OpenWalnut 1.2.5
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 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.
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.


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.

WItemSelectionItem::~WItemSelectionItem ( ) [virtual]

Destruction.

Does NOT delete the icon!

Definition at line 37 of file WItemSelectionItem.cpp.


Member Function Documentation

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 93 of file WItemSelectionItem.h.

Referenced by getDescription().

const char** WItemSelectionItem::m_icon [protected]

Item icon.

Definition at line 98 of file WItemSelectionItem.h.

Referenced by getIcon().

std::string WItemSelectionItem::m_name [protected]

Item name.

Definition at line 88 of file WItemSelectionItem.h.

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


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends