Blender  V3.3
List of all members
blender::ed::outliner::TreeElementOverridesPropertyOperation Class Referencefinal

#include <tree_element_overrides.hh>

Inheritance diagram for blender::ed::outliner::TreeElementOverridesPropertyOperation:
blender::ed::outliner::TreeElementOverridesProperty blender::ed::outliner::AbstractTreeElement

Overridden Property Operation

See TreeElementOverridesPropertyOperation.

 TreeElementOverridesPropertyOperation (TreeElement &legacy_te, TreeElementOverridesData &override_data)
 
StringRefNull getOverrideOperationLabel () const
 
std::optional< BIFIconIDgetIcon () const override
 

Additional Inherited Members

- Public Member Functions inherited from blender::ed::outliner::TreeElementOverridesProperty
bool isCollectionOperation () const
 
 TreeElementOverridesProperty (TreeElement &legacy_te, TreeElementOverridesData &override_data)
 
StringRefNull getWarning () const override
 
- Public Member Functions inherited from blender::ed::outliner::AbstractTreeElement
virtual ~AbstractTreeElement ()=default
 
virtual bool expandPoll (const SpaceOutliner &) const
 
virtual bool isExpandValid () const
 
TreeElementgetLegacyElement ()
 
- Static Public Member Functions inherited from blender::ed::outliner::AbstractTreeElement
static std::unique_ptr< AbstractTreeElementcreateFromType (int type, TreeElement &legacy_te, void *idv)
 
static void uncollapse_by_default (TreeElement *legacy_te)
 
- Public Attributes inherited from blender::ed::outliner::TreeElementOverridesProperty
PointerRNA override_rna_ptr
 
PropertyRNAoverride_rna_prop
 
StringRefNull rna_path
 
bool is_rna_path_valid
 
- Protected Member Functions inherited from blender::ed::outliner::AbstractTreeElement
 AbstractTreeElement (TreeElement &legacy_te)
 
virtual void expand (SpaceOutliner &) const
 
- Protected Attributes inherited from blender::ed::outliner::AbstractTreeElement
TreeElementlegacy_te_
 

Detailed Description

Represent a single operation within an overridden property. While usually a single override property represents a single operation (changing the value), a single overridden collection property may have multiple operations, e.g. to insert or remove collection items.

Inherits from the override property class since it should look/behave mostly the same.

Definition at line 75 of file tree_element_overrides.hh.

Constructor & Destructor Documentation

◆ TreeElementOverridesPropertyOperation()

blender::ed::outliner::TreeElementOverridesPropertyOperation::TreeElementOverridesPropertyOperation ( TreeElement legacy_te,
TreeElementOverridesData override_data 
)

Member Function Documentation

◆ getIcon()

std::optional< BIFIconID > blender::ed::outliner::TreeElementOverridesPropertyOperation::getIcon ( ) const
overridevirtual

Define the icon to be displayed for this element. If this returns an icon, this will be displayed. Otherwise, tree_element_get_icon() may still determine an icon. By default no value is returned (#std::nullopt).

All elements should be ported to use this over tree_element_get_icon().

Reimplemented from blender::ed::outliner::AbstractTreeElement.

Definition at line 236 of file tree_element_overrides.cc.

References RNA_struct_ui_icon().

◆ getOverrideOperationLabel()

StringRefNull blender::ed::outliner::TreeElementOverridesPropertyOperation::getOverrideOperationLabel ( ) const

Return a short string to display in the right column of the properties mode, indicating what the override operation did (e.g. added or removed a collection item).

Definition at line 224 of file tree_element_overrides.cc.

References BLI_assert_unreachable, ELEM, IDOVERRIDE_LIBRARY_OP_INSERT_AFTER, IDOVERRIDE_LIBRARY_OP_INSERT_BEFORE, and TIP_.


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