Abstract base class for defining a customizable tree-view item. More...

#include <UI_tree_view.hh>

Inherits blender::ui::AbstractViewItem, and blender::ui::TreeViewItemContainer.

Inherited by blender::ed::object::shapekey::ShapeKeyItem, blender::ed::spreadsheet::DataSetViewItem, blender::ed::spreadsheet::InstancesTreeViewItem, blender::ed::spreadsheet::ViewerDataTreeItem, blender::ed::spreadsheet::ViewerPathTreeViewItem, blender::ui::BasicTreeViewItem, blender::ui::bonecollections::BoneCollectionItem, blender::ui::greasepencil::LayerGroupViewItem, and blender::ui::greasepencil::LayerViewItem.

Public Member Functions
	~AbstractTreeViewItem () override=default
virtual void	build_row (uiLayout &row)=0
std::optional< std::string >	debug_name () const override
std::unique_ptr< DropTargetInterface >	create_item_drop_target () final
virtual std::unique_ptr< TreeViewItemDropTarget >	create_drop_target ()
AbstractTreeView &	get_tree_view () const
std::optional< rctf >	get_win_rect (const ARegion &region) const
void	begin_renaming ()
bool	toggle_collapsed ()
virtual bool	set_collapsed (bool collapsed)
virtual void	on_collapse_change (bContext &C, bool is_collapsed)
virtual std::optional< bool >	should_be_collapsed () const
void	uncollapse_by_default ()
bool	is_collapsed () const
bool	is_collapsible () const
int	count_parents () const
void	on_filter_change () override
Public Member Functions inherited from blender::ui::AbstractViewItem
virtual	~AbstractViewItem ()=default
virtual void	build_context_menu (bContext &C, uiLayout &column) const
virtual void	on_activate (bContext &C)
virtual std::optional< bool >	should_be_active () const
virtual std::optional< bool >	should_be_selected () const
virtual void	set_selected (const bool select)
void	activate (bContext &C)
void	activate_for_context_menu (bContext &C)
void	deactivate ()
virtual std::unique_ptr< AbstractViewItemDragController >	create_drag_controller () const
AbstractView &	get_view () const
uiButViewItem *	view_item_button () const
void	disable_interaction ()
bool	is_interactive () const
void	disable_activatable ()
void	select_on_click_set ()
bool	is_select_on_click () const
void	always_reactivate_on_click ()
void	activate_for_context_menu_set ()
bool	is_active () const
bool	is_selected () const
bool	is_search_highlight () const
virtual bool	supports_renaming () const
bool	is_renaming () const
void	begin_renaming ()
void	end_renaming ()
void	rename_apply (const bContext &C)
virtual void	delete_item (bContext *C)
bool	is_filtered_visible () 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
StringRef	get_rename_string () const override
bool	rename (const bContext &C, StringRefNull new_name) override
virtual bool	supports_collapsing () const
void	toggle_collapsed_from_view (bContext &C)
void	change_state_delayed () override
bool	matches (const AbstractViewItem &other) const override
void	update_from_old (const AbstractViewItem &old) override
virtual bool	matches_single (const AbstractTreeViewItem &other) const
bool	is_hovered () const
void	ensure_parents_uncollapsed ()
Protected Member Functions inherited from blender::ui::AbstractViewItem
	AbstractViewItem ()=default
void	add_rename_button (uiBlock &block)
virtual bool	should_be_filtered_visible (StringRefNull filter_string) const
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

Protected Attributes
std::string	label_
Protected Attributes inherited from blender::ui::AbstractViewItem
AbstractView *	view_ = nullptr
uiButViewItem *	view_item_but_ = nullptr
bool	is_activatable_ = true
bool	is_interactive_ = true
bool	is_active_ = false
bool	is_selected_ = false
bool	is_renaming_ = false
bool	is_highlighted_search_ = false
bool	is_filtered_visible_ = true
bool	is_always_collapsible_ = false
bool	select_on_click_ = false
bool	reactivate_on_click_ = false
bool	activate_for_context_menu_ = false
Protected Attributes inherited from blender::ui::TreeViewItemContainer
Vector< std::unique_ptr< AbstractTreeViewItem > >	children_
TreeViewItemContainer *	root_ = nullptr
AbstractTreeViewItem *	parent_ = nullptr
bool	is_flat_ = false

Friends
class	AbstractTreeView
class	TreeViewLayoutBuilder
class	TreeViewItemAPIWrapper

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 &)>

Detailed Description

Abstract base class for defining a customizable tree-view item.

The tree-view item defines how to build its data into a tree-row. There are implementations for common layouts, e.g. BasicTreeViewItem. It also stores state information that needs to be persistent over redraws, like the collapsed state.

Definition at line 212 of file UI_tree_view.hh.

Constructor & Destructor Documentation

◆ ~AbstractTreeViewItem()

blender::ui::AbstractTreeViewItem::~AbstractTreeViewItem ( )

overridedefault

Member Function Documentation

◆ begin_renaming()

void blender::ui::AbstractTreeViewItem::begin_renaming ( )

◆ build_row()

virtual void blender::ui::AbstractTreeViewItem::build_row ( uiLayout & row )

pure virtual

References AbstractTreeView, create_drop_target(), final, get_tree_view(), and get_win_rect().

Referenced by blender::ui::TreeViewLayoutBuilder::build_row().

◆ change_state_delayed()

void blender::ui::AbstractTreeViewItem::change_state_delayed ( )

overrideprotectedvirtual

See #AbstractView::change_state_delayed(). Overrides should call the base class implementation.

Reimplemented from blender::ui::AbstractViewItem.

Definition at line 760 of file tree_view.cc.

References blender::ui::AbstractViewItem::change_state_delayed(), get_tree_view(), blender::ui::AbstractViewItem::is_active(), set_collapsed(), and should_be_collapsed().

Referenced by begin_renaming().

◆ count_parents()

int blender::ui::AbstractTreeViewItem::count_parents ( ) const

Definition at line 662 of file tree_view.cc.

References blender::ui::TreeViewItemContainer::AbstractTreeViewItem, i, and blender::ui::TreeViewItemContainer::parent_.

Referenced by begin_renaming(), blender::ed::asset::shelf::AssetCatalogSelectorTree::build_catalog_items_recursive(), blender::ed::asset::shelf::AssetCatalogTreeView::build_catalog_items_recursive(), and matches().

◆ create_drop_target()

std::unique_ptr< TreeViewItemDropTarget > blender::ui::AbstractTreeViewItem::create_drop_target ( )

virtual

Reimplemented in blender::ed::asset_browser::AssetCatalogTreeViewItem, blender::ed::object::shapekey::ShapeKeyItem, blender::ui::bonecollections::BoneCollectionItem, blender::ui::greasepencil::LayerGroupViewItem, and blender::ui::greasepencil::LayerViewItem.

Definition at line 634 of file tree_view.cc.

Referenced by build_row(), and create_item_drop_target().

◆ create_item_drop_target()

std::unique_ptr< DropTargetInterface > blender::ui::AbstractTreeViewItem::create_item_drop_target ( )

finalvirtual

If an item wants to support dropping data into it, it has to return a drop target here. That is an object implementing DropTargetInterface.

Note: This drop target may be requested for each event. The view doesn't keep a drop target around currently. So it can not contain persistent state.

Reimplemented from blender::ui::AbstractViewItem.

Definition at line 629 of file tree_view.cc.

References create_drop_target().

Referenced by blender::ui::region_views_find_drop_target_at().

◆ debug_name()

std::optional< std::string > blender::ui::AbstractTreeViewItem::debug_name ( ) const

overridevirtual

View types should implement this to return some name or identifier of the item, which is helpful for debugging (there's nothing to identify the item just from the AbstractViewItem otherwise).

Reimplemented from blender::ui::AbstractViewItem.

Definition at line 639 of file tree_view.cc.

References label_.

◆ ensure_parents_uncollapsed()

void blender::ui::AbstractTreeViewItem::ensure_parents_uncollapsed ( )

protected

Definition at line 777 of file tree_view.cc.

References blender::ui::TreeViewItemContainer::AbstractTreeViewItem, and blender::ui::TreeViewItemContainer::parent_.

Referenced by begin_renaming().

◆ get_rename_string()

StringRef blender::ui::AbstractTreeViewItem::get_rename_string ( ) const

overrideprotectedvirtual

See AbstractViewItem::get_rename_string().

Reimplemented from blender::ui::AbstractViewItem.

Reimplemented in blender::ed::object::shapekey::ShapeKeyItem, blender::ui::bonecollections::BoneCollectionItem, blender::ui::greasepencil::LayerGroupViewItem, and blender::ui::greasepencil::LayerViewItem.

Definition at line 603 of file tree_view.cc.

References label_.

Referenced by begin_renaming().

◆ get_tree_view()

AbstractTreeView & blender::ui::AbstractTreeViewItem::get_tree_view ( ) const

Definition at line 644 of file tree_view.cc.

References AbstractTreeView, and blender::ui::AbstractViewItem::get_view().

Referenced by blender::ed::asset::shelf::AssetCatalogSelectorTree::Item::build_row(), build_row(), change_state_delayed(), blender::ed::asset_browser::AssetCatalogTreeViewItem::create_drag_controller(), blender::ed::object::shapekey::ShapeKeyItem::create_drag_controller(), blender::ui::bonecollections::BoneCollectionItem::create_drag_controller(), blender::ui::greasepencil::LayerGroupViewItem::create_drag_controller(), blender::ui::greasepencil::LayerViewItem::create_drag_controller(), blender::ed::asset_browser::AssetCatalogTreeViewItem::delete_item(), blender::ed::spreadsheet::DataSetViewItem::get_tree(), blender::ed::spreadsheet::InstancesTreeViewItem::get_tree(), is_collapsed(), is_collapsible(), is_hovered(), blender::ed::asset_browser::AssetCatalogTreeViewItem::on_activate(), blender::ed::spreadsheet::ViewerDataTreeItem::on_activate(), on_filter_change(), blender::ed::asset_browser::AssetCatalogTreeViewItem::rename(), blender::ed::spreadsheet::ViewerDataTreeItem::should_be_active(), blender::ed::asset_browser::AssetCatalogTreeViewItem::supports_renaming(), and uncollapse_by_default().

◆ get_win_rect()

std::optional< rctf > blender::ui::AbstractTreeViewItem::get_win_rect ( const ARegion & region ) const

Calculate the view item rectangle from its view-item button, converted to window space. Returns an unset optional if there is no view item button for this item.

Definition at line 649 of file tree_view.cc.

References uiBut::block, uiBut::rect, ui_block_to_window_rctf(), and blender::ui::AbstractViewItem::view_item_button().

Referenced by build_row(), and blender::ui::AbstractTreeView::find_hovered().

◆ is_collapsed()

bool blender::ui::AbstractTreeViewItem::is_collapsed ( ) const

Requires the tree to have completed reconstruction, see #is_reconstructed(). Otherwise we can't be sure about the item state.

Definition at line 696 of file tree_view.cc.

References BLI_assert_msg, get_tree_view(), and is_collapsible().

Referenced by begin_renaming(), blender::ui::bonecollections::BoneCollectionItem::on_collapse_change(), blender::ui::greasepencil::LayerGroupViewItem::on_collapse_change(), blender::ui::bonecollections::BoneCollectionItem::should_be_collapsed(), blender::ui::greasepencil::LayerGroupViewItem::should_be_collapsed(), and toggle_collapsed_from_view().

◆ is_collapsible()

bool blender::ui::AbstractTreeViewItem::is_collapsible ( ) const

Definition at line 747 of file tree_view.cc.

References BLI_assert_msg, blender::ui::TreeViewItemContainer::children_, get_tree_view(), blender::ui::AbstractViewItem::is_always_collapsible_, and supports_collapsing().

Referenced by begin_renaming(), is_collapsed(), and set_collapsed().

◆ is_hovered()

bool blender::ui::AbstractTreeViewItem::is_hovered ( ) const

protected

Can be called from the #AbstractTreeViewItem::build_row() implementation, but not earlier. The hovered state can't be queried reliably otherwise. Note that this does a linear lookup in the old block, so isn't too great performance-wise.

Definition at line 682 of file tree_view.cc.

References BLI_assert_msg, uiBut::flag, get_tree_view(), ui_block_view_find_matching_view_item_but_in_old_block(), UI_HOVER, and blender::ui::AbstractViewItem::view_item_but_.

Referenced by begin_renaming(), and blender::ed::asset_browser::AssetCatalogTreeViewItem::build_row().

◆ matches()

bool blender::ui::AbstractTreeViewItem::matches ( const AbstractViewItem & other ) const

overrideprotectedvirtual

See #AbstractViewItem::matches().

Implements blender::ui::AbstractViewItem.

Definition at line 784 of file tree_view.cc.

References blender::ui::TreeViewItemContainer::AbstractTreeViewItem, blender::ui::AbstractViewItem::AbstractViewItem(), count_parents(), matches_single(), and blender::ui::TreeViewItemContainer::parent_.

Referenced by begin_renaming().

◆ matches_single()

bool blender::ui::AbstractTreeViewItem::matches_single ( const AbstractTreeViewItem & other ) const

protectedvirtual

Compare this item to other to check if they represent the same data. Used to recognize an item from a previous redraw, to be able to keep its state (e.g. open/closed, active, etc.). Items are only matched if their parents also match. By default this just matches the item's label (if the parents match!). If that isn't good enough for a sub-class, that can override it.

TODO matches_single() is a rather temporary name, used to indicate that this only compares the item itself, not the parents. Item matching is expected to change quite a bit anyway.

Definition at line 624 of file tree_view.cc.

References blender::ui::TreeViewItemContainer::AbstractTreeViewItem, and label_.

Referenced by begin_renaming(), and matches().

◆ on_collapse_change()

void blender::ui::AbstractTreeViewItem::on_collapse_change	(	bContext &	C,
		bool	is_collapsed )

virtual

Called when the view changes an item's state from expanded to collapsed, or vice versa. Will only be called if the state change is triggered through the view, not through external changes. E.g. a click on an item calls it, a change in the value returned by should_be_collapsed() to reflect an external state change does not.

Reimplemented in blender::ui::bonecollections::BoneCollectionItem, and blender::ui::greasepencil::LayerGroupViewItem.

Definition at line 728 of file tree_view.cc.

Referenced by begin_renaming(), and toggle_collapsed_from_view().