Inheritance diagram for Exponent::GUI::Controls::CMenuItem:
Definition at line 41 of file CMenuItem.hpp.
Types of menu item.
Definition at line 57 of file CMenuItem.hpp.
Exponent::GUI::Controls::CMenuItem::CMenuItem | ( | const CString & | text, | |
const long | identifier, | |||
const EMenuItemTypes | type = e_menuItemNormal , |
|||
const bool | enabled = true | |||
) |
Construction
text | The string to display | |
identifier | The identifier to use | |
type | The type of menu item | |
enabled | If false menuis disabled, else enabled |
virtual Exponent::GUI::Controls::CMenuItem::~CMenuItem | ( | ) | [virtual] |
Destruction
virtual void Exponent::GUI::Controls::CMenuItem::enable | ( | const bool | enabled = true |
) | [inline, virtual] |
Enable the unit
enabled | If false menuis disabled, else enabled |
Definition at line 107 of file CMenuItem.hpp.
References m_isEnabled.
virtual long Exponent::GUI::Controls::CMenuItem::getId | ( | ) | const [inline, virtual] |
Get the id
long | The menu unique id |
Definition at line 138 of file CMenuItem.hpp.
References m_id.
virtual long Exponent::GUI::Controls::CMenuItem::getIndex | ( | ) | const [inline, virtual] |
Get the index
long | The local menu index of this item |
Definition at line 156 of file CMenuItem.hpp.
References m_index.
virtual IImage* Exponent::GUI::Controls::CMenuItem::getNormalImage | ( | ) | const [inline, virtual] |
Get the normal image
IImage* | The normal image |
Definition at line 162 of file CMenuItem.hpp.
References m_normalImage.
virtual IImage* Exponent::GUI::Controls::CMenuItem::getRolloverImage | ( | ) | const [inline, virtual] |
Get the rollover image
IImage* | The rollover image |
Definition at line 168 of file CMenuItem.hpp.
References m_rolloverImage.
virtual const CString& Exponent::GUI::Controls::CMenuItem::getText | ( | ) | const [inline, virtual] |
Get the text
const | CString& The string being displayed |
Definition at line 132 of file CMenuItem.hpp.
References m_text.
const CAlphaColour& Exponent::GUI::Controls::CMenuItem::getTextColour | ( | ) | const [inline] |
Get the text colour
const | CAlphaColour & The colour to be used to draw this menu item |
Definition at line 180 of file CMenuItem.hpp.
References m_textColour.
virtual EMenuItemTypes Exponent::GUI::Controls::CMenuItem::getType | ( | ) | const [inline, virtual] |
Get the type
EMenuItemTypes | The type of menu item |
Definition at line 144 of file CMenuItem.hpp.
References m_type.
virtual bool Exponent::GUI::Controls::CMenuItem::isEnabled | ( | ) | const [inline, virtual] |
is the menu item enabled?
bool | True if menu is enabled, false otheriwse |
Definition at line 150 of file CMenuItem.hpp.
References m_isEnabled.
bool Exponent::GUI::Controls::CMenuItem::overrideTextColour | ( | ) | const [inline] |
Chck if text colours should be overridden
bool | True if text colour can be overridden, false otherwise |
Definition at line 194 of file CMenuItem.hpp.
References m_overrideTextColour.
void Exponent::GUI::Controls::CMenuItem::overrideTextColour | ( | const bool | override | ) | [inline] |
Should the colour be overwridden? If this is true, then m_textColour is used for drawing, else default colours of the menu window are used
override | If true text is drawn with text col |
Definition at line 188 of file CMenuItem.hpp.
References m_overrideTextColour.
virtual void Exponent::GUI::Controls::CMenuItem::setId | ( | const long | id | ) | [inline, virtual] |
Set the id
id | The identifier to use |
Definition at line 95 of file CMenuItem.hpp.
References m_id.
virtual void Exponent::GUI::Controls::CMenuItem::setImages | ( | IImage * | normalImage, | |
IImage * | rolloverImage | |||
) | [inline, virtual] |
Set the images
normalImage | The icon to use when mouse is not over or down | |
rolloverImage | THe icon to use when mouse is over or down |
Definition at line 120 of file CMenuItem.hpp.
References EXCHANGE_COUNTED_OBJECTS, m_normalImage, and m_rolloverImage.
virtual void Exponent::GUI::Controls::CMenuItem::setIndex | ( | const long | index | ) | [inline, virtual] |
Set the index
index | The local menu index |
Definition at line 113 of file CMenuItem.hpp.
References m_index.
virtual void Exponent::GUI::Controls::CMenuItem::setText | ( | const CString & | text | ) | [inline, virtual] |
Set the text
text | The string to display |
Definition at line 89 of file CMenuItem.hpp.
References m_text.
void Exponent::GUI::Controls::CMenuItem::setTextColour | ( | const CAlphaColour & | colour | ) | [inline] |
Set the text colour
colour | The colour to use for text |
Definition at line 174 of file CMenuItem.hpp.
References m_textColour.
virtual void Exponent::GUI::Controls::CMenuItem::setType | ( | const EMenuItemTypes | type | ) | [inline, virtual] |
Set the type
type | The type of menu item |
Definition at line 101 of file CMenuItem.hpp.
References m_type.
long Exponent::GUI::Controls::CMenuItem::m_id [protected] |
The identifier of the menu
Definition at line 203 of file CMenuItem.hpp.
long Exponent::GUI::Controls::CMenuItem::m_index [protected] |
The index within this menu
Definition at line 204 of file CMenuItem.hpp.
Referenced by getIndex(), and setIndex().
bool Exponent::GUI::Controls::CMenuItem::m_isEnabled [protected] |
Is the item enabled?
Definition at line 206 of file CMenuItem.hpp.
Referenced by enable(), and isEnabled().
IImage* Exponent::GUI::Controls::CMenuItem::m_normalImage [protected] |
The normal image
Definition at line 207 of file CMenuItem.hpp.
Referenced by getNormalImage(), and setImages().
bool Exponent::GUI::Controls::CMenuItem::m_overrideTextColour [protected] |
Is m_textCOlour valid?
Definition at line 210 of file CMenuItem.hpp.
Referenced by overrideTextColour().
The image to use on rollover..
Definition at line 208 of file CMenuItem.hpp.
Referenced by getRolloverImage(), and setImages().
CString Exponent::GUI::Controls::CMenuItem::m_text [protected] |
The display string
Definition at line 202 of file CMenuItem.hpp.
Colour of the text to draw
Definition at line 209 of file CMenuItem.hpp.
Referenced by getTextColour(), and setTextColour().
The type of menu item
Definition at line 205 of file CMenuItem.hpp.