Ember
Loading...
Searching...
No Matches
EmberForge::PanelDescriptor Class Reference

Descriptor that tracks panel metadata. More...

#include <PanelDescriptor.h>

Public Member Functions

 PanelDescriptor (PanelType type, int hierarchyLevel=0, PanelDescriptor *parent=nullptr)
PanelType GetType () const
 Get the panel type.
int GetHierarchyLevel () const
 Get the hierarchy level (0 = main panel)
PanelDescriptor * GetParent () const
 Get the parent panel descriptor (nullptr for main panels)
wxString GetDisplayName () const
 Get a display name for this panel type.
wxString GetPaneName () const
 Get the AUI pane name for this panel (used by wxAUI)

Private Attributes

PanelType m_type
int m_hierarchyLevel
PanelDescriptor * m_parent

Detailed Description

Descriptor that tracks panel metadata.

This class maintains information about a panel's type and provides display names and AUI pane names.

Definition at line 25 of file PanelDescriptor.h.

Constructor & Destructor Documentation

◆ PanelDescriptor()

EmberForge::PanelDescriptor::PanelDescriptor ( PanelType type,
int hierarchyLevel = 0,
PanelDescriptor * parent = nullptr )
inlineexplicit

Definition at line 27 of file PanelDescriptor.h.

Member Function Documentation

◆ GetDisplayName()

wxString EmberForge::PanelDescriptor::GetDisplayName ( ) const
inline

Get a display name for this panel type.

Definition at line 48 of file PanelDescriptor.h.

◆ GetHierarchyLevel()

int EmberForge::PanelDescriptor::GetHierarchyLevel ( ) const
inline

Get the hierarchy level (0 = main panel)

Definition at line 38 of file PanelDescriptor.h.

◆ GetPaneName()

wxString EmberForge::PanelDescriptor::GetPaneName ( ) const
inline

Get the AUI pane name for this panel (used by wxAUI)

Definition at line 64 of file PanelDescriptor.h.

◆ GetParent()

PanelDescriptor * EmberForge::PanelDescriptor::GetParent ( ) const
inline

Get the parent panel descriptor (nullptr for main panels)

Definition at line 43 of file PanelDescriptor.h.

◆ GetType()

PanelType EmberForge::PanelDescriptor::GetType ( ) const
inline

Get the panel type.

Definition at line 33 of file PanelDescriptor.h.

Member Data Documentation

◆ m_hierarchyLevel

int EmberForge::PanelDescriptor::m_hierarchyLevel
private

Definition at line 79 of file PanelDescriptor.h.

◆ m_parent

PanelDescriptor* EmberForge::PanelDescriptor::m_parent
private

Definition at line 80 of file PanelDescriptor.h.

◆ m_type

PanelType EmberForge::PanelDescriptor::m_type
private

Definition at line 78 of file PanelDescriptor.h.

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