Inherits blender::ui::AbstractTreeViewItem.

Inherited by blender::ed::spreadsheet::InstanceReferenceViewItem, and blender::ed::spreadsheet::RootGeometryViewItem.

Public Member Functions
GeometryInstancesTreeView &	get_tree () const

void	get_parent_instance_ids (Vector< SpreadsheetInstanceID > &r_instance_ids) const

void	on_activate (bContext &C) override

std::optional< bool >	should_be_active () const override

Public Member Functions inherited from blender::ui::AbstractTreeViewItem
	~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)

void	uncollapse_by_default ()

bool	is_collapsed () const

bool	is_collapsible () const

int	count_parents () const

virtual void	on_collapse_change (bContext &C, bool is_collapsed)

virtual std::optional< bool >	should_be_collapsed () const

Public Member Functions inherited from blender::ui::AbstractViewItem
virtual	~AbstractViewItem ()=default

virtual void	build_context_menu (bContext &C, uiLayout &column) const

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

bool	is_active () const

bool	is_search_highlight () const

void	activate (bContext &C)

void	deactivate ()

virtual bool	supports_renaming () const

bool	is_renaming () const

void	begin_renaming ()

void	end_renaming ()

void	rename_apply (const 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)

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 Member Functions inherited from blender::ui::AbstractTreeViewItem
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 inherited from blender::ui::AbstractTreeViewItem
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_renaming_ = false

bool	is_highlighted_search_ = false

bool	is_filtered_visible_ = true

Protected Attributes inherited from blender::ui::TreeViewItemContainer
Vector< std::unique_ptr< AbstractTreeViewItem > >	children_

TreeViewItemContainer *	root_ = nullptr

AbstractTreeViewItem *	parent_ = nullptr

Detailed Description

Definition at line 125 of file spreadsheet_dataset_draw.cc.

Member Function Documentation

◆ get_parent_instance_ids()

void blender::ed::spreadsheet::InstancesTreeViewItem::get_parent_instance_ids ( Vector< SpreadsheetInstanceID > & r_instance_ids ) const

Definition at line 600 of file spreadsheet_dataset_draw.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::Vector< T, InlineBufferCapacity, Allocator >::begin(), blender::Vector< T, InlineBufferCapacity, Allocator >::end(), and blender::ui::TreeViewItemContainer::foreach_parent().

Referenced by on_activate(), and should_be_active().

◆ get_tree()

GeometryInstancesTreeView & blender::ed::spreadsheet::InstancesTreeViewItem::get_tree ( ) const

Definition at line 595 of file spreadsheet_dataset_draw.cc.

References blender::ui::AbstractTreeViewItem::get_tree_view().

Referenced by should_be_active().

◆ on_activate()

void blender::ed::spreadsheet::InstancesTreeViewItem::on_activate ( bContext & C )

overridevirtual

Called when the view changes an item's state from inactive to active. 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_active() to reflect an external state change does not.

Reimplemented from blender::ui::AbstractViewItem.

Definition at line 634 of file spreadsheet_dataset_draw.cc.

References CTX_wm_space_spreadsheet(), blender::Vector< T, InlineBufferCapacity, Allocator >::data(), get_parent_instance_ids(), blender::initialized_copy_n(), SpaceSpreadsheet::instance_ids, SpaceSpreadsheet::instance_ids_num, MEM_SAFE_FREE, NC_SPACE, ND_SPACE_SPREADSHEET, blender::Vector< T, InlineBufferCapacity, Allocator >::size(), and WM_main_add_notifier().

◆ should_be_active()

std::optional< bool > blender::ed::spreadsheet::InstancesTreeViewItem::should_be_active ( ) const

overridevirtual

If the result is not empty, it controls whether the item should be active or not, usually depending on the data that the view represents. Note that since this is meant to reflect externally managed state changes, on_activate() will never be called if this returns true.

Reimplemented from blender::ui::AbstractViewItem.

Definition at line 614 of file spreadsheet_dataset_draw.cc.

References b, get_parent_instance_ids(), get_tree(), blender::Vector< T, InlineBufferCapacity, Allocator >::index_range(), SpaceSpreadsheet::instance_ids, SpaceSpreadsheet::instance_ids_num, and blender::Vector< T, InlineBufferCapacity, Allocator >::size().

The documentation for this class was generated from the following file:

spreadsheet_dataset_draw.cc