Blender  V3.3
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
blender::ed::outliner::TreeElementRNACommon Class Reference

#include <tree_element_rna.hh>

Inheritance diagram for blender::ed::outliner::TreeElementRNACommon:
blender::ed::outliner::AbstractTreeElement blender::ed::outliner::TreeElementRNAArrayElement blender::ed::outliner::TreeElementRNAProperty blender::ed::outliner::TreeElementRNAStruct

Public Member Functions

 TreeElementRNACommon (TreeElement &legacy_te, PointerRNA &rna_ptr)
 
bool isExpandValid () const override
 
bool expandPoll (const SpaceOutliner &) const override
 
const PointerRNAgetPointerRNA () const
 
virtual PropertyRNAgetPropertyRNA () const
 
bool isRNAValid () const
 
- Public Member Functions inherited from blender::ed::outliner::AbstractTreeElement
virtual ~AbstractTreeElement ()=default
 
TreeElementgetLegacyElement ()
 
virtual StringRefNull getWarning () const
 
virtual std::optional< BIFIconIDgetIcon () const
 

Protected Attributes

PointerRNA rna_ptr_
 
- Protected Attributes inherited from blender::ed::outliner::AbstractTreeElement
TreeElementlegacy_te_
 

Static Protected Attributes

constexpr static int max_index = std::numeric_limits<short>::max()
 

Additional Inherited Members

- 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)
 
- Protected Member Functions inherited from blender::ed::outliner::AbstractTreeElement
 AbstractTreeElement (TreeElement &legacy_te)
 
virtual void expand (SpaceOutliner &) const
 

Detailed Description

Base class for common behavior of RNA tree elements.

Definition at line 22 of file tree_element_rna.hh.

Constructor & Destructor Documentation

◆ TreeElementRNACommon()

blender::ed::outliner::TreeElementRNACommon::TreeElementRNACommon ( TreeElement legacy_te,
PointerRNA rna_ptr 
)

Definition at line 35 of file tree_element_rna.cc.

References IFACE_.

Member Function Documentation

◆ expandPoll()

bool blender::ed::outliner::TreeElementRNACommon::expandPoll ( const SpaceOutliner ) const
overridevirtual

Check if the type is expandable in current context.

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

Definition at line 55 of file tree_element_rna.cc.

References isRNAValid().

◆ getPointerRNA()

const PointerRNA & blender::ed::outliner::TreeElementRNACommon::getPointerRNA ( ) const

◆ getPropertyRNA()

PropertyRNA * blender::ed::outliner::TreeElementRNACommon::getPropertyRNA ( ) const
virtual

If this element represents a property or is part of a property (array element), this returns the property. Otherwise nullptr.

Reimplemented in blender::ed::outliner::TreeElementRNAArrayElement, and blender::ed::outliner::TreeElementRNAProperty.

Definition at line 65 of file tree_element_rna.cc.

Referenced by do_outliner_drivers_editop(), and do_outliner_keyingset_editop().

◆ isExpandValid()

bool blender::ed::outliner::TreeElementRNACommon::isExpandValid ( ) const
overridevirtual

Just while transitioning to the new tree-element design: Some types are only partially ported, and the expanding isn't done yet.

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

Definition at line 45 of file tree_element_rna.cc.

◆ isRNAValid()

bool blender::ed::outliner::TreeElementRNACommon::isRNAValid ( ) const

Member Data Documentation

◆ max_index

constexpr static int blender::ed::outliner::TreeElementRNACommon::max_index = std::numeric_limits<short>::max()
staticconstexprprotected

◆ rna_ptr_

PointerRNA blender::ed::outliner::TreeElementRNACommon::rna_ptr_
protected

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