Blender  V3.3
Public Member Functions | List of all members
blender::ed::outliner::TreeElementLabel Class Referencefinal

#include <tree_element_label.hh>

Inheritance diagram for blender::ed::outliner::TreeElementLabel:
blender::ed::outliner::AbstractTreeElement

Public Member Functions

 TreeElementLabel (TreeElement &legacy_te, const char *label)
 
void setIcon (BIFIconID icon)
 
std::optional< BIFIconIDgetIcon () 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 ()
 
virtual StringRefNull getWarning () const
 

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
 
- Protected Attributes inherited from blender::ed::outliner::AbstractTreeElement
TreeElementlegacy_te_
 

Detailed Description

A basic, general purpose tree element to just display a label and an icon. Can be used to group together items underneath as well of course.

Make sure to give this a unique index, so the element can be identified uniquely. Otherwise glitches like multiple highlighted elements happen, that share all state (e.g. collapsed, selected, etc.).

Definition at line 25 of file tree_element_label.hh.

Constructor & Destructor Documentation

◆ TreeElementLabel()

blender::ed::outliner::TreeElementLabel::TreeElementLabel ( TreeElement legacy_te,
const char *  label 
)

Member Function Documentation

◆ getIcon()

std::optional< BIFIconID > blender::ed::outliner::TreeElementLabel::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 31 of file tree_element_label.cc.

◆ setIcon()

void blender::ed::outliner::TreeElementLabel::setIcon ( BIFIconID  icon)

Definition at line 26 of file tree_element_label.cc.


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