griefith/test
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: UI: Improve comment for UI list filter function

Browse Source 
I needed some clarification for this myself, noting important findings
in the comment.
This commit is contained in:
Julian Eisel
2025-06-19 11:33:32 +02:00
parent f27358fde7
commit d292df83b7
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
source/blender/editors/include/UI_interface.hh
View File

@@ -258,9 +258,13 @@ using uiListItemGetNameFn =
blender::FunctionRef<std::string(const PointerRNA &itemptr, int index)>;
/**
* Filter list items using \a item_filter_fn and sort the result. This respects the normal UI list
* filter settings like alphabetical sorting (#UILST_FLT_SORT_ALPHA), and result inverting
* (#UILST_FLT_EXCLUDE).
* Helper to apply custom filtering to UI lists not defined in Python. Custom filtering for
* Python UI lists has own code. This is also used as the default filtering if no
* #uiListType::filter_items callback is set.
*
* Filters list items using \a item_filter_fn and sorts the result. Also handles alphabetical
* sorting (#UILST_FLT_SORT_ALPHA), and result inverting (#UILST_FLT_EXCLUDE) if enabled, so the
* callback doesn't have to do this (unlike the filter function in Python).
*
* Call this from a #uiListType::filter_items callback with any #item_filter_fn. #uiListNameFilter
* can be used to apply the default name based filtering.