OpenWalnut
1.4.0
|
Class for keeping a single named item in a WItemSelection. More...
#include <WItemSelectionItem.h>
Public Types | |
typedef boost::shared_ptr < WItemSelectionItem > | SPtr |
Abbreviation for a shared pointer. | |
typedef boost::shared_ptr < const WItemSelectionItem > | ConstSPtr |
Abbreviation for a const shared pointer. | |
Public Member Functions | |
WItemSelectionItem (std::string name, std::string description="", const char **icon=NULL) | |
Constructs a new item with the specified values. | |
virtual | ~WItemSelectionItem () |
Destruction. | |
std::string | getName () const |
Returns the name of the item. | |
std::string | getDescription () const |
The description of the item. | |
const char ** | getIcon () const |
The icon associated with this item. | |
template<typename T > | |
T * | getAs () |
Dynamic cast of the object, if a derivative of WItemSelectionItem was add to WItemSelection. | |
template<typename T > | |
const T * | getAs () const |
Dynamic cast of the object, if a derivative of WItemSelectionItem was add to WItemSelection. | |
bool | operator== (const WItemSelectionItem &other) const |
Compares this and another item using their names only. | |
Protected Attributes | |
std::string | m_name |
Item name. | |
std::string | m_description |
Item description. | |
const char ** | m_icon |
Item icon. |
Class for keeping a single named item in a WItemSelection.
Definition at line 35 of file WItemSelectionItem.h.
typedef boost::shared_ptr< const WItemSelectionItem > WItemSelectionItem::ConstSPtr |
Abbreviation for a const shared pointer.
Reimplemented in WItemSelectionItemTyped< T >.
Definition at line 46 of file WItemSelectionItem.h.
typedef boost::shared_ptr< WItemSelectionItem > WItemSelectionItem::SPtr |
Abbreviation for a shared pointer.
Reimplemented in WItemSelectionItemTyped< T >.
Definition at line 41 of file WItemSelectionItem.h.
WItemSelectionItem::WItemSelectionItem | ( | std::string | name, |
std::string | description = "" , |
||
const char ** | icon = NULL |
||
) |
Constructs a new item with the specified values.
name | Name of item. |
description | Description, can be empty. |
icon | Icon, can be NULL. |
Definition at line 29 of file WItemSelectionItem.cpp.
WItemSelectionItem::~WItemSelectionItem | ( | ) | [virtual] |
T* WItemSelectionItem::getAs | ( | ) | [inline] |
Dynamic cast of the object, if a derivative of WItemSelectionItem was add to WItemSelection.
Definition at line 89 of file WItemSelectionItem.h.
const T* WItemSelectionItem::getAs | ( | ) | const [inline] |
Dynamic cast of the object, if a derivative of WItemSelectionItem was add to WItemSelection.
Definition at line 100 of file WItemSelectionItem.h.
std::string WItemSelectionItem::getDescription | ( | ) | const |
The description of the item.
Definition at line 47 of file WItemSelectionItem.cpp.
References m_description.
const char ** WItemSelectionItem::getIcon | ( | ) | const |
The icon associated with this item.
Can be NULL.
Definition at line 52 of file WItemSelectionItem.cpp.
References m_icon.
std::string WItemSelectionItem::getName | ( | ) | const |
Returns the name of the item.
Definition at line 42 of file WItemSelectionItem.cpp.
References m_name.
bool WItemSelectionItem::operator== | ( | const WItemSelectionItem & | other | ) | const |
Compares this and another item using their names only.
other | the second to compare the this one with |
Definition at line 57 of file WItemSelectionItem.cpp.
References m_name.
std::string WItemSelectionItem::m_description [protected] |
Item description.
Definition at line 123 of file WItemSelectionItem.h.
Referenced by getDescription().
const char** WItemSelectionItem::m_icon [protected] |
std::string WItemSelectionItem::m_name [protected] |
Item name.
Definition at line 118 of file WItemSelectionItem.h.
Referenced by getName(), and operator==().