|
Blender V5.3
|
#include <UI_tree_view.hh>
Inherits blender::ui::AbstractView, and blender::ui::TreeViewItemContainer.
Inherited by blender::AssetLibraryList< AssetLibraryListItemType, AssetLibraryRepoItemType >, blender::ed::asset::shelf::AssetCatalogSelectorTree, blender::ed::asset::shelf::AssetCatalogTreeView, blender::ed::asset_browser::AssetCatalogTreeView, blender::ed::object::shapekey::ShapeKeyTreeView, blender::ed::spreadsheet::GeometryDataSetTreeView, blender::ed::spreadsheet::GeometryInstancesTreeView, blender::ed::spreadsheet::ViewerDataTreeView, blender::ed::spreadsheet::ViewerPathTreeView, blender::ui::bonecollections::BoneCollectionTreeView, and blender::ui::greasepencil::LayerTreeView.
Public Member Functions | |
| ~AbstractTreeView () override=default | |
| void | draw_overlays (const ARegion ®ion, const Block &block) const override |
| void | foreach_item (ItemIterFn iter_fn, IterOptions options=IterOptions::None) const |
| void | foreach_root_item (ItemIterFn iter_fn) const |
| bool | is_fully_visible () const override |
| void | scroll (ViewScrollDirection direction) override |
| void | set_default_rows (int default_rows) |
| TreeViewSortOrder | invert_sort_type_get () const |
| void | scroll_active_into_view (bContext *C, bool scroll_active_to_center=false) override |
| Public Member Functions inherited from blender::ui::AbstractView | |
| virtual | ~AbstractView ()=default |
| void | register_item (AbstractViewItem &item) |
| virtual std::unique_ptr< DropTargetInterface > | create_drop_target () |
| virtual bool | listen (const wmNotifier &) const |
| virtual bool | begin_filtering (const bContext &C) const |
| bool | is_renaming () const |
| bool | begin_renaming () |
| void | end_renaming () |
| Span< char > | get_rename_buffer () const |
| MutableSpan< char > | get_rename_buffer () |
| std::optional< rcti > | get_bounds () const |
| std::string | get_context_menu_title () const |
| void | set_context_menu_title (const std::string &title) |
| bool | get_popup_keep_open () const |
| void | set_popup_keep_open () |
| void | clear_search_highlight () |
| void | allow_multiselect_items () |
| bool | is_multiselect_supported () const |
| Public Member Functions inherited from blender::ui::TreeViewItemContainer | |
| template<class ItemT, typename... Args> | |
| ItemT & | add_tree_item (Args &&...args) |
| AbstractTreeViewItem & | add_tree_item (std::unique_ptr< AbstractTreeViewItem > item) |
Protected Member Functions | |
| virtual void | build_tree ()=0 |
| std::optional< uiViewState > | persistent_state () const override |
| void | persistent_state_apply (const uiViewState &state) override |
| Protected Member Functions inherited from blender::ui::AbstractView | |
| AbstractView ()=default | |
| virtual void | change_state_delayed () |
| void | update_from_old (Block &new_block) |
| bool | is_reconstructed () const |
| const AbstractViewItem * | search_highlight_item () const |
| void | filter (std::optional< StringRef > filter_str) |
| Protected Member Functions inherited from blender::ui::TreeViewItemContainer | |
| 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) |
Friends | |
| class | AbstractTreeViewItem |
| class | TreeViewBuilder |
| class | TreeViewLayoutBuilder |
| class | TreeViewItemDropTarget |
Additional Inherited Members | |
| Public Types inherited from blender::ui::TreeViewItemContainer | |
| enum class | IterOptions { None = 0 , SkipCollapsed = 1 << 0 , SkipFiltered = 1 << 1 } |
| using | ItemIterFn = FunctionRef<void(AbstractTreeViewItem &)> |
| Protected Attributes inherited from blender::ui::TreeViewItemContainer | |
| Vector< std::unique_ptr< AbstractTreeViewItem > > | children_ |
| TreeViewItemContainer * | root_ = nullptr |
| AbstractTreeViewItem * | parent_ = nullptr |
| bool | is_flat_ = false |
Definition at line 125 of file UI_tree_view.hh.
|
overridedefault |
|
protectedpure virtual |
Implemented in blender::AssetLibraryList< AssetLibraryListItemType, AssetLibraryRepoItemType >, blender::ed::asset::shelf::AssetCatalogSelectorTree, blender::ed::asset::shelf::AssetCatalogTreeView, blender::ed::asset_browser::AssetCatalogTreeView, blender::ed::object::shapekey::ShapeKeyTreeView, blender::ed::spreadsheet::GeometryDataSetTreeView, blender::ed::spreadsheet::GeometryInstancesTreeView, blender::ed::spreadsheet::ViewerDataTreeView, blender::ed::spreadsheet::ViewerPathTreeView, blender::ui::bonecollections::BoneCollectionTreeView, and blender::ui::greasepencil::LayerTreeView.
References AbstractTreeViewItem, blender::ui::AbstractView::AbstractView(), blender::ui::AbstractView::AbstractViewItem, C, persistent_state(), persistent_state_apply(), and state.
Referenced by blender::ui::TreeViewBuilder::build_tree_view().
|
overridevirtual |
Reimplemented from blender::ui::AbstractView.
Definition at line 430 of file tree_view.cc.
Referenced by ~AbstractTreeView().
| void blender::ui::AbstractTreeView::foreach_item | ( | ItemIterFn | iter_fn, |
| IterOptions | options = IterOptions::None ) const |
Definition at line 127 of file tree_view.cc.
References blender::ui::TreeViewItemContainer::foreach_item_recursive(), and options.
Referenced by blender::ui::TreeViewLayoutBuilder::build_from_tree(), blender::ui::count_visible_items(), scroll_active_into_view(), blender::ed::asset::shelf::AssetCatalogSelectorTree::update_shelf_settings_from_enabled_catalogs(), and ~AbstractTreeView().
| void blender::ui::AbstractTreeView::foreach_root_item | ( | ItemIterFn | iter_fn | ) | const |
Definition at line 132 of file tree_view.cc.
References blender::ui::TreeViewItemContainer::children_.
Referenced by ~AbstractTreeView().
| TreeViewSortOrder blender::ui::AbstractTreeView::invert_sort_type_get | ( | ) | const |
Definition at line 370 of file tree_view.cc.
Referenced by ~AbstractTreeView().
|
overridevirtual |
Reimplemented from blender::ui::AbstractView.
Definition at line 503 of file tree_view.cc.
Referenced by ~AbstractTreeView().
|
overrideprotectedvirtual |
From the current view state, return certain state that will be written to files (stored in #ARegion.view_states) to preserve it over UI changes and file loading. The state can be restored using persistent_state_apply().
Return an empty value if there's no state to preserve (default implementation).
Reimplemented from blender::ui::AbstractView.
Definition at line 242 of file tree_view.cc.
References SET_FLAG_FROM_TEST, state, blender::STRNCPY(), UI_INV_SCALE_FAC, blender::UI_VIEW_FILTER_INVERT, blender::UI_VIEW_SHOW_FILTER_OPTIONS, and blender::UI_VIEW_SORT_ALPHA.
Referenced by build_tree().
|
overrideprotectedvirtual |
Restore a view state given in state, which was created by persistent_state() for saving in files, and potentially loaded from a file.
Reimplemented from blender::ui::AbstractView.
Definition at line 265 of file tree_view.cc.
References blender::BLI_strncpy(), MIN_ROWS, blender::ui::padded_item_height(), blender::round_fl_to_int(), set_default_rows(), state, UI_MAX_NAME_STR, UI_SCALE_FAC, blender::UI_VIEW_FILTER_INVERT, blender::UI_VIEW_SHOW_FILTER_OPTIONS, and blender::UI_VIEW_SORT_ALPHA.
Referenced by build_tree().
|
overridevirtual |
Reimplemented from blender::ui::AbstractView.
Definition at line 508 of file tree_view.cc.
References blender::ui::UP.
Referenced by ~AbstractTreeView().
|
overridevirtual |
Scroll the view so the active item is visible.
Implements blender::ui::AbstractView.
Definition at line 517 of file tree_view.cc.
References AbstractTreeViewItem, foreach_item(), blender::ui::AbstractViewItem::is_active_, blender::ui::TreeViewItemContainer::SkipCollapsed, and blender::ui::TreeViewItemContainer::SkipFiltered.
Referenced by blender::ui::TreeViewLayoutBuilder::build_from_tree(), and ~AbstractTreeView().
| void blender::ui::AbstractTreeView::set_default_rows | ( | int | default_rows | ) |
Visual feature: Define a number of item rows the view will show by default. If there are fewer items, empty dummy items will be added. These contribute to the view bounds, so the drop target of the view includes them, but they are not interactive (e.g. no mouse-hover highlight).
Definition at line 234 of file tree_view.cc.
References BLI_assert_msg, MIN_ROWS, and blender::ui::padded_item_height().
Referenced by blender::draw_library_list(), persistent_state_apply(), blender::ui::template_bone_collection_tree(), blender::ui::template_grease_pencil_layer_tree(), blender::ui::template_light_linking_collection(), blender::ed::object::shapekey::template_tree(), blender::ui::template_tree_interface(), and ~AbstractTreeView().
|
friend |
Definition at line 161 of file UI_tree_view.hh.
References AbstractTreeViewItem.
Referenced by AbstractTreeViewItem, build_tree(), and scroll_active_into_view().
|
friend |
Definition at line 162 of file UI_tree_view.hh.
References TreeViewBuilder.
Referenced by TreeViewBuilder.
|
friend |
Definition at line 164 of file UI_tree_view.hh.
References TreeViewItemDropTarget.
Referenced by TreeViewItemDropTarget.
|
friend |
Definition at line 163 of file UI_tree_view.hh.
References TreeViewLayoutBuilder.
Referenced by TreeViewLayoutBuilder.