Blender V4.3
blender::ed::outliner::TreeElementRNACommon Class Reference

#include <tree_element_rna.hh>

Inherits blender::ed::outliner::AbstractTreeElement.

Inherited by blender::ed::outliner::TreeElementRNAArrayElement, blender::ed::outliner::TreeElementRNAProperty, and blender::ed::outliner::TreeElementRNAStruct.

Public Member Functions

 TreeElementRNACommon (TreeElement &legacy_te, PointerRNA &rna_ptr)
 
bool expand_poll (const SpaceOutliner &) const override
 
const PointerRNAget_pointer_rna () const
 
virtual PropertyRNAget_property_rna () const
 
bool is_rna_valid () const
 
- Public Member Functions inherited from blender::ed::outliner::AbstractTreeElement
virtual ~AbstractTreeElement ()=default
 
TreeElementget_legacy_element ()
 
virtual StringRefNull get_warning () const
 
virtual std::optional< BIFIconIDget_icon () const
 
void print_path ()
 

Protected Attributes

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

Static Protected Attributes

static constexpr 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< AbstractTreeElementcreate_from_type (int type, TreeElement &legacy_te, ID *owner_id, void *create_data)
 
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
 
TreeElementadd_element (ListBase *lb, ID *owner_id, void *create_data, TreeElement *parent, short type, short index, const bool expand=true) const
 

Detailed Description

Base class for common behavior of RNA tree elements.

Definition at line 24 of file tree_element_rna.hh.

Constructor & Destructor Documentation

◆ TreeElementRNACommon()

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

Definition at line 36 of file tree_element_rna.cc.

References IFACE_.

Member Function Documentation

◆ expand_poll()

bool blender::ed::outliner::TreeElementRNACommon::expand_poll ( const SpaceOutliner & ) const
overridevirtual

Check if the type is expandable in current context.

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

Definition at line 51 of file tree_element_rna.cc.

References is_rna_valid().

◆ get_pointer_rna()

◆ get_property_rna()

PropertyRNA * blender::ed::outliner::TreeElementRNACommon::get_property_rna ( ) 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 61 of file tree_element_rna.cc.

Referenced by blender::ed::outliner::do_outliner_drivers_editop(), and blender::ed::outliner::do_outliner_keyingset_editop().

◆ is_rna_valid()

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

Member Data Documentation

◆ max_index

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: