Lumiera  0.pre.03
»edityourfreedom«
PanelManager::PanelDescription Class Reference

Description

A class to describe and instantiate Panel types.

Definition at line 234 of file panel-manager.hpp.

Public Member Functions

panel::Panelcreate (PanelManager &panelManager, Gdl::DockItem &dockItem) const
 Creates an instance of this panel. More...
 
const std::type_info & getClassInfo () const
 
const char * getClassName () const
 
const gchar * getStockID () const
 
const char * getTitle () const
 the localised title that will be shown on the panel More...
 

Protected Types

typedef panel::Panel *(*const CreatePanelProc) (PanelManager &, Gdl::DockItem &)
 

Protected Member Functions

 PanelDescription (std::type_info const &classInfo, const char *title, const gchar *stockID, CreatePanelProc createPanelProc)
 

Private Attributes

const std::type_info & classInfo_
 reference to the typeID of this class More...
 
CreatePanelProc createPanelProc_
 pointer to a function that will instantiate the panel object More...
 
const gchar *const stockID_
 Stock ID for this type of panel. More...
 
const char *const titleName_
 localised title that will be shown on the panel. More...
 

Member Typedef Documentation

◆ CreatePanelProc

typedef panel::Panel*(*const CreatePanelProc) (PanelManager &, Gdl::DockItem &)
protected

Definition at line 237 of file panel-manager.hpp.

Constructor & Destructor Documentation

◆ PanelDescription()

PanelDescription ( std::type_info const &  classInfo,
const char *  title,
const gchar *  stockID,
CreatePanelProc  createPanelProc 
)
inlineprotected
Parameters
classInfoThe typeID of the Panel class
titleThe localised title that will be shown on the panel.
stock_idThe Stock ID for this type of panel.
create_panel_procA pointer to a function that will instantiate the panel object.

Definition at line 260 of file panel-manager.hpp.

Member Function Documentation

◆ getClassInfo()

const std::type_info& getClassInfo ( ) const
inline

Definition at line 274 of file panel-manager.hpp.

◆ getClassName()

const char* getClassName ( ) const
inline

Definition at line 279 of file panel-manager.hpp.

◆ getTitle()

const char* getTitle ( ) const
inline

the localised title that will be shown on the panel

Definition at line 285 of file panel-manager.hpp.

References ENSURE().

Referenced by PanelManager::getPanelTitle().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getStockID()

const gchar* getStockID ( ) const
inline

Definition at line 291 of file panel-manager.hpp.

References ENSURE().

Referenced by PanelManager::getPanelStockID().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ create()

panel::Panel* create ( PanelManager panelManager,
Gdl::DockItem &  dockItem 
) const
inline

Creates an instance of this panel.

Parameters
panel_managerThe owner panel manager.
dock_itemThe GdlDockItem that will host this panel.
Returns
Returns a pointer to the panel object.

Definition at line 305 of file panel-manager.hpp.

Referenced by PanelManager::createPanel_by_index().

+ Here is the caller graph for this function:

Member Data Documentation

◆ classInfo_

const std::type_info& classInfo_
private

reference to the typeID of this class

Definition at line 241 of file panel-manager.hpp.

◆ titleName_

const char* const titleName_
private

localised title that will be shown on the panel.

Definition at line 244 of file panel-manager.hpp.

◆ stockID_

const gchar* const stockID_
private

Stock ID for this type of panel.

Definition at line 247 of file panel-manager.hpp.

◆ createPanelProc_

CreatePanelProc createPanelProc_
private

pointer to a function that will instantiate the panel object

Definition at line 250 of file panel-manager.hpp.

+ Inheritance diagram for PanelManager::PanelDescription:
+ Collaboration diagram for PanelManager::PanelDescription:

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