Inherits blender::ui::AbstractTreeViewItem.

Public Member Functions
	BoneCollectionItem (bArmature &armature, const int bcoll_index, const bool has_any_selected_bones)

void	build_row (uiLayout &row) override

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

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

void	on_activate (bContext &C) override

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

bool	set_collapsed (const bool collapsed) override

void	on_collapse_change (bContext &C, const bool is_collapsed) override

bool	supports_renaming () const override

bool	rename (const bContext &C, StringRefNull new_name) override

StringRef	get_rename_string () const override

std::unique_ptr< AbstractViewItemDragController >	create_drag_controller () const override

std::unique_ptr< TreeViewItemDropTarget >	create_drop_target () override

Public Member Functions inherited from blender::ui::AbstractTreeViewItem
	~AbstractTreeViewItem () override=default

std::optional< std::string >	debug_name () const override

std::unique_ptr< DropTargetInterface >	create_item_drop_target () final

AbstractTreeView &	get_tree_view () const

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

void	begin_renaming ()

bool	toggle_collapsed ()

void	uncollapse_by_default ()

bool	is_collapsed () const

bool	is_collapsible () const

int	count_parents () const

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

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

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)

Protected Member Functions
PointerRNA	rna_pointer ()

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

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::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 201 of file interface_template_bone_collection_tree.cc.

Constructor & Destructor Documentation

◆ BoneCollectionItem()

blender::ui::bonecollections::BoneCollectionItem::BoneCollectionItem	(	bArmature &	armature,
		const int	bcoll_index,
		const bool	has_any_selected_bones )

inline

Definition at line 209 of file interface_template_bone_collection_tree.cc.

References blender::ui::AbstractTreeViewItem::label_, and BoneCollection::name.

Member Function Documentation

◆ build_context_menu()

void blender::ui::bonecollections::BoneCollectionItem::build_context_menu	(	bContext &	C,
		uiLayout &	column ) const

inlineoverridevirtual

Reimplemented from blender::ui::AbstractViewItem.

Definition at line 264 of file interface_template_bone_collection_tree.cc.

References UI_menutype_draw(), and WM_menutype_find().

◆ build_row()

void blender::ui::bonecollections::BoneCollectionItem::build_row ( uiLayout & row )

inlineoverridevirtual

Implements blender::ui::AbstractTreeViewItem.

Definition at line 218 of file interface_template_bone_collection_tree.cc.

References ANIM_armature_bonecoll_contains_active_bone(), ANIM_armature_bonecoll_is_editable(), ARM_BCOLL_SOLO_ACTIVE, bArmature::flag, BoneCollection::name, rna_pointer(), UI_but_flag_enable(), UI_BUT_INACTIVE, UI_ITEM_R_ICON_ONLY, uiItemL(), uiItemL_ex(), uiItemR(), uiLayoutRow(), and uiLayoutSetActive().

◆ create_drag_controller()

std::unique_ptr< AbstractViewItemDragController > blender::ui::bonecollections::BoneCollectionItem::create_drag_controller ( ) const

inlineoverridevirtual

If an item wants to support being dragged, it has to return a drag controller here. That is an object implementing #AbstractViewItemDragController.

Reimplemented from blender::ui::AbstractViewItem.

Definition at line 346 of file interface_template_bone_collection_tree.cc.

References ANIM_armature_bonecoll_is_editable(), and blender::ui::AbstractTreeViewItem::get_tree_view().

◆ create_drop_target()

std::unique_ptr< TreeViewItemDropTarget > blender::ui::bonecollections::BoneCollectionItem::create_drop_target ( )

inlineoverridevirtual

Reimplemented from blender::ui::AbstractTreeViewItem.

Definition at line 357 of file interface_template_bone_collection_tree.cc.

References blender::ui::ReorderAndInsert.

◆ get_rename_string()

StringRef blender::ui::bonecollections::BoneCollectionItem::get_rename_string ( ) const

inlineoverridevirtual

See AbstractViewItem::get_rename_string().

Reimplemented from blender::ui::AbstractTreeViewItem.

Definition at line 341 of file interface_template_bone_collection_tree.cc.

References BoneCollection::name.

◆ on_activate()

void blender::ui::bonecollections::BoneCollectionItem::on_activate ( bContext & C )

inlineoverridevirtual

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 278 of file interface_template_bone_collection_tree.cc.

References ED_undo_push(), bArmature::id, RNA_pointer_create(), RNA_property_int_set(), RNA_property_update(), and RNA_struct_find_property().

◆ on_collapse_change()

void blender::ui::bonecollections::BoneCollectionItem::on_collapse_change	(	bContext &	C,
		const bool	is_collapsed )

inlineoverridevirtual

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 from blender::ui::AbstractTreeViewItem.

Definition at line 308 of file interface_template_bone_collection_tree.cc.

References bArmature::id, blender::ui::AbstractTreeViewItem::is_collapsed(), RNA_pointer_create(), RNA_property_boolean_set(), RNA_property_update(), and RNA_struct_find_property().

◆ rename()

bool blender::ui::bonecollections::BoneCollectionItem::rename	(	const bContext &	C,
		StringRefNull	new_name )

inlineoverridevirtual

See AbstractViewItem::rename().

Reimplemented from blender::ui::AbstractTreeViewItem.

Definition at line 327 of file interface_template_bone_collection_tree.cc.

References blender::StringRefNull::c_str(), ED_undo_push(), rna_pointer(), RNA_property_string_set(), RNA_property_update(), and RNA_struct_find_property().

◆ rna_pointer()

PointerRNA blender::ui::bonecollections::BoneCollectionItem::rna_pointer ( )

inlineprotected

RNA pointer to the BoneCollection.

Definition at line 368 of file interface_template_bone_collection_tree.cc.

References bArmature::id, and RNA_pointer_create().

Referenced by build_row(), and rename().

◆ set_collapsed()

bool blender::ui::bonecollections::BoneCollectionItem::set_collapsed ( const bool collapsed )

inlineoverridevirtual

Expand or collapse this tree view item.

Note: this does not call on_collapse_change().

Returns: true when the collapsed state was changed, false otherwise.

Reimplemented from blender::ui::AbstractTreeViewItem.

Definition at line 297 of file interface_template_bone_collection_tree.cc.

References ANIM_armature_bonecoll_is_expanded_set(), and blender::ui::AbstractTreeViewItem::set_collapsed().

◆ should_be_active()

std::optional< bool > blender::ui::bonecollections::BoneCollectionItem::should_be_active ( ) const

inlineoverridevirtual

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 273 of file interface_template_bone_collection_tree.cc.

References bArmature_Runtime::active_collection_index, and bArmature::runtime.