OpenWalnut  1.4.0
Public Types | Public Member Functions | Protected Attributes
WItemSelectionItem Class Reference

Class for keeping a single named item in a WItemSelection. More...

#include <WItemSelectionItem.h>

+ Inheritance diagram for WItemSelectionItem:

List of all members.

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.

Detailed Description

Class for keeping a single named item in a WItemSelection.

Definition at line 35 of file WItemSelectionItem.h.


Member Typedef Documentation

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.


Constructor & Destructor Documentation

WItemSelectionItem::WItemSelectionItem ( std::string  name,
std::string  description = "",
const char **  icon = NULL 
)

Constructs a new item with the specified values.

Parameters:
nameName of item.
descriptionDescription, can be empty.
iconIcon, can be NULL.

Definition at line 29 of file WItemSelectionItem.cpp.

Destruction.

Does NOT delete the icon!

Definition at line 37 of file WItemSelectionItem.cpp.


Member Function Documentation

template<typename T >
T* WItemSelectionItem::getAs ( ) [inline]

Dynamic cast of the object, if a derivative of WItemSelectionItem was add to WItemSelection.

Returns:
Returns the converted item of new type T or 0 if a conversion is not possible.

Definition at line 89 of file WItemSelectionItem.h.

template<typename T >
const T* WItemSelectionItem::getAs ( ) const [inline]

Dynamic cast of the object, if a derivative of WItemSelectionItem was add to WItemSelection.

Returns:
Returns the converted item of new type T or 0 if a conversion is not possible.

Definition at line 100 of file WItemSelectionItem.h.

std::string WItemSelectionItem::getDescription ( ) const

The description of the item.

Returns:
the description

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.

Returns:
the icon, might be NULL.

Definition at line 52 of file WItemSelectionItem.cpp.

References m_icon.

std::string WItemSelectionItem::getName ( ) const

Returns the name of the item.

Returns:
the name

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.

Parameters:
otherthe second to compare the this one with
Returns:
true if the names are equal.

Definition at line 57 of file WItemSelectionItem.cpp.

References m_name.


Member Data Documentation

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]

Item icon.

Definition at line 128 of file WItemSelectionItem.h.

Referenced by getIcon().

std::string WItemSelectionItem::m_name [protected]

Item name.

Definition at line 118 of file WItemSelectionItem.h.

Referenced by getName(), and operator==().


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