|
Blender V5.3
|
#include <UI_tree_view.hh>
Inherited by blender::ui::AbstractTreeView, and blender::ui::AbstractTreeViewItem.
Public Types | |
| enum class | IterOptions { None = 0 , SkipCollapsed = 1 << 0 , SkipFiltered = 1 << 1 } |
| using | ItemIterFn = FunctionRef<void(AbstractTreeViewItem &)> |
Public Member Functions | |
| template<class ItemT, typename... Args> | |
| ItemT & | add_tree_item (Args &&...args) |
| AbstractTreeViewItem & | add_tree_item (std::unique_ptr< AbstractTreeViewItem > item) |
Protected Member Functions | |
| void | foreach_item_recursive (ItemIterFn iter_fn, IterOptions options=IterOptions::None) const |
| void | foreach_parent (ItemIterFn iter_fn) const |
| void | sort_alpha () |
| void | foreach_sort_invert (TreeViewSortOrder order) |
Protected Attributes | |
| Vector< std::unique_ptr< AbstractTreeViewItem > > | children_ |
| TreeViewItemContainer * | root_ = nullptr |
| AbstractTreeViewItem * | parent_ = nullptr |
| bool | is_flat_ = false |
Friends | |
| class | AbstractTreeView |
| class | AbstractTreeViewItem |
Both the tree-view (as the root of the tree) and the items can have children. This is the base class for both, to store and manage child items. Children are owned by their parent container (tree-view or item).
That means this type can be used whenever either an AbstractTreeView or an AbstractTreeViewItem is needed, but the TreeViewOrItem alias is a better name to use then.
Definition at line 54 of file UI_tree_view.hh.
Definition at line 80 of file UI_tree_view.hh.
|
strong |
| Enumerator | |
|---|---|
| None | |
| SkipCollapsed | |
| SkipFiltered | |
Definition at line 75 of file UI_tree_view.hh.
|
inline |
Convenience wrapper constructing the item by forwarding given arguments to the constructor of the type (ItemT).
E.g. if your tree-item type has the following constructor:
You can add an item like this:
Definition at line 474 of file UI_tree_view.hh.
References add_tree_item().
Referenced by add_tree_item(), blender::ed::spreadsheet::ViewerPathTreeView::add_viewer_path_elem(), blender::ed::spreadsheet::GeometryDataSetTreeView::build_bundle_children(), blender::ed::spreadsheet::ViewerDataTreeView::build_bundle_children(), blender::ed::asset::shelf::AssetCatalogSelectorTree::build_catalog_items_recursive(), blender::ed::asset::shelf::AssetCatalogTreeView::build_catalog_items_recursive(), blender::ed::spreadsheet::GeometryDataSetTreeView::build_closure_children(), blender::ed::spreadsheet::ViewerDataTreeView::build_closure_children(), blender::AssetLibraryList< AssetLibraryListItemType, AssetLibraryRepoItemType >::build_tree(), blender::ed::asset::shelf::AssetCatalogSelectorTree::build_tree(), blender::ed::asset::shelf::AssetCatalogTreeView::build_tree(), blender::ed::object::shapekey::ShapeKeyTreeView::build_tree(), blender::ed::spreadsheet::GeometryInstancesTreeView::build_tree(), blender::ed::spreadsheet::ViewerDataTreeView::build_tree(), blender::ed::spreadsheet::GeometryDataSetTreeView::build_tree_for_bundle(), blender::ed::spreadsheet::GeometryDataSetTreeView::build_tree_for_curves(), blender::ed::spreadsheet::GeometryDataSetTreeView::build_tree_for_grease_pencil(), blender::ed::spreadsheet::GeometryDataSetTreeView::build_tree_for_instances(), blender::ed::spreadsheet::GeometryInstancesTreeView::build_tree_for_instances(), blender::ed::spreadsheet::GeometryDataSetTreeView::build_tree_for_mesh(), blender::ed::spreadsheet::GeometryDataSetTreeView::build_tree_for_pointcloud(), and blender::ed::spreadsheet::GeometryDataSetTreeView::build_tree_for_volume().
| AbstractTreeViewItem & blender::ui::TreeViewItemContainer::add_tree_item | ( | std::unique_ptr< AbstractTreeViewItem > | item | ) |
Add an already constructed tree item to this parent. Ownership is moved to it. All tree items must be added through this, it handles important invariants!
Definition at line 44 of file tree_view.cc.
References AbstractTreeView, AbstractTreeViewItem, children_, parent_, blender::ui::AbstractView::register_item(), and root_.
|
protected |
Definition at line 67 of file tree_view.cc.
References children_, options, SkipCollapsed, and SkipFiltered.
Referenced by blender::ui::AbstractTreeView::foreach_item(), blender::ed::asset::shelf::AssetCatalogSelectorTree::Item::has_enabled_in_subtree(), and blender::ed::spreadsheet::DataSetViewItem::on_activate().
|
protected |
Definition at line 87 of file tree_view.cc.
References AbstractTreeViewItem, and parent_.
Referenced by blender::ed::spreadsheet::GeometryBundleItemViewItem::get_geometry_data_id(), blender::ed::spreadsheet::InstancesTreeViewItem::get_parent_instance_ids(), blender::ed::spreadsheet::ViewerDataTreeItem::items_path(), and blender::ui::AbstractTreeViewItem::on_filter().
|
protected |
Definition at line 109 of file tree_view.cc.
References children_, and blender::ui::InvertNested.
|
protected |
Definition at line 94 of file tree_view.cc.
References b, blender::BLI_strcasecmp_natural(), blender::StringRefNull::c_str(), and children_.
Referenced by blender::ui::TreeViewBuilder::build_tree_view().
|
friend |
Definition at line 55 of file UI_tree_view.hh.
References AbstractTreeView.
Referenced by AbstractTreeView, and add_tree_item().
|
friend |
Definition at line 56 of file UI_tree_view.hh.
References AbstractTreeViewItem.
Referenced by AbstractTreeViewItem, add_tree_item(), and foreach_parent().
|
protected |
Definition at line 62 of file UI_tree_view.hh.
Referenced by add_tree_item(), foreach_item_recursive(), blender::ui::AbstractTreeView::foreach_root_item(), foreach_sort_invert(), blender::ui::AbstractTreeViewItem::get_child(), blender::ui::AbstractTreeViewItem::is_collapsible(), and sort_alpha().
|
protected |
Can be set to true to indicate that all of the children items do not have children themselves. In this case, no space is reserved for the chevron.
Definition at line 72 of file UI_tree_view.hh.
Referenced by blender::AssetLibraryList< AssetLibraryListItemType, AssetLibraryRepoItemType >::build_tree(), blender::ed::asset::shelf::AssetCatalogSelectorTree::build_tree(), blender::ed::asset::shelf::AssetCatalogTreeView::build_tree(), blender::ed::object::shapekey::ShapeKeyTreeView::ShapeKeyTreeView(), and blender::ed::spreadsheet::ViewerPathTreeView::ViewerPathTreeView().
|
protected |
Pointer back to the owning item.
Definition at line 66 of file UI_tree_view.hh.
Referenced by add_tree_item(), blender::ui::AbstractTreeViewItem::count_parents(), blender::ui::AbstractTreeViewItem::ensure_parents_uncollapsed(), foreach_parent(), blender::ui::AbstractTreeViewItem::get_parent(), and blender::ui::AbstractTreeViewItem::matches().
|
protected |
Adding the first item to the root will set this, then it's passed on to all children.
Definition at line 64 of file UI_tree_view.hh.
Referenced by add_tree_item().