OpenWalnut
1.4.0
|
This is a base class for everything which has a Name,Description,Icon and Properties (=NDIP). More...
#include <WObjectNDIP.h>
Inherits T.
Public Types | |
typedef boost::shared_ptr < WObjectNDIP > | SPtr |
Shared ptr to an instance. | |
typedef boost::shared_ptr < const WObjectNDIP > | ConstSPtr |
Shared ptr to a const instance. | |
Public Member Functions | |
virtual | ~WObjectNDIP () |
Destructor. | |
virtual std::string | getName () const |
The name of the object. | |
virtual std::string | getDescription () const |
The description of this object. | |
virtual const char ** | getIcon () const |
The icon of this object. | |
virtual WProperties::SPtr | getProperties () |
Return the property group of this object. | |
Protected Member Functions | |
WObjectNDIP (std::string name, std::string description, const char **icon=NULL) | |
Construct a NDIP'ed object. | |
Protected Attributes | |
WProperties::SPtr | m_properties |
the properties of the object. | |
Private Attributes | |
std::string | m_name |
the name | |
std::string | m_description |
the description | |
const char ** | m_icon |
the icon |
This is a base class for everything which has a Name,Description,Icon and Properties (=NDIP).
Just derive from this class and you get the NDIP stuff for free. Managed for you.
Definition at line 41 of file WObjectNDIP.h.
typedef boost::shared_ptr< const WObjectNDIP > WObjectNDIP< T >::ConstSPtr |
Shared ptr to a const instance.
Reimplemented in WGEViewerEffect, WGEViewerEffectImageOverlay, WGEViewerEffectHorizon, and WGEViewerEffectVignette.
Definition at line 52 of file WObjectNDIP.h.
typedef boost::shared_ptr< WObjectNDIP > WObjectNDIP< T >::SPtr |
Shared ptr to an instance.
Reimplemented in WGEViewerEffect, WGEViewerEffectImageOverlay, WGEViewerEffectHorizon, and WGEViewerEffectVignette.
Definition at line 47 of file WObjectNDIP.h.
WObjectNDIP< T >::~WObjectNDIP | ( | ) | [virtual] |
Destructor.
Implement if you have non trivial cleanup stuff.
Definition at line 118 of file WObjectNDIP.h.
WObjectNDIP< T >::WObjectNDIP | ( | std::string | name, |
std::string | description, | ||
const char ** | icon = NULL |
||
) | [protected] |
Construct a NDIP'ed object.
name | the name |
description | the description |
icon | an icon in XPM format. Can be NULL if no icon is required. |
Definition at line 108 of file WObjectNDIP.h.
std::string WObjectNDIP< T >::getDescription | ( | ) | const [virtual] |
The description of this object.
Definition at line 130 of file WObjectNDIP.h.
const char ** WObjectNDIP< T >::getIcon | ( | ) | const [virtual] |
The icon of this object.
Definition at line 136 of file WObjectNDIP.h.
std::string WObjectNDIP< T >::getName | ( | ) | const [virtual] |
WProperties::SPtr WObjectNDIP< T >::getProperties | ( | ) | [virtual] |
Return the property group of this object.
Definition at line 142 of file WObjectNDIP.h.
std::string WObjectNDIP< T >::m_description [private] |
the description
Definition at line 103 of file WObjectNDIP.h.
const char** WObjectNDIP< T >::m_icon [private] |
the icon
Definition at line 104 of file WObjectNDIP.h.
std::string WObjectNDIP< T >::m_name [private] |
the name
Definition at line 102 of file WObjectNDIP.h.
WProperties::SPtr WObjectNDIP< T >::m_properties [protected] |
the properties of the object.
Definition at line 99 of file WObjectNDIP.h.