PLGui::MenuItem Class Reference

Represents an item in a menu structure. More...

#include <MenuItem.h>

Inheritance diagram for PLGui::MenuItem:

List of all members.

Public Member Functions
PLGUI_API	MenuItem (Gui &cGui)
	Constructor.
PLGUI_API	MenuItem (Gui &cGui, const PLCore::String &sText)
	Constructor.
PLGUI_API	MenuItem (Gui &cGui, const PLCore::String &sText, const Image &cIcon)
	Constructor.
virtual PLGUI_API	~MenuItem ()
	Destructor.
PLGUI_API Gui *	GetGui () const
	Get owner GUI.
PLGUI_API EMenuItemType	GetType () const
	Get type of menu item.
PLGUI_API PLCore::uint32	GetID () const
	Get command ID.
PLGUI_API void	SetID (PLCore::uint32 nID)
	Set command ID.
PLGUI_API PLCore::String	GetText () const
	Get item text.
PLGUI_API void	SetText (const PLCore::String &sText)
	Set item text.
PLGUI_API const Image &	GetIcon () const
	Get icon.
PLGUI_API void	SetIcon (const Image &cIcon)
	Set icon.
PLGUI_API char	GetShortcut () const
	Get shortcut of menu item (e.g. if text is "&Test" -> 'T' is the shortcut)
Protected Member Functions
PLGUI_API	MenuItem (Gui &cGui, EMenuItemType nType)
	Constructor.
Protected Attributes
Gui *	m_pGui
EMenuItemType	m_nType
PLCore::uint32	m_nCommandID
PLCore::String	m_sText
Image	m_cIcon

---

Detailed Description

Represents an item in a menu structure.

---

Constructor & Destructor Documentation

PLGUI_API PLGui::MenuItem::MenuItem

(

Gui &

cGui

)

Constructor.

Parameters:

[in]

cGui

Owner GUI

PLGUI_API PLGui::MenuItem::MenuItem	(	Gui &	cGui,
		const PLCore::String &	sText
	)

Constructor.

Parameters:

[in]	cGui	Owner GUI
[in]	sText	Text of the menu item

PLGUI_API PLGui::MenuItem::MenuItem	(	Gui &	cGui,
		const PLCore::String &	sText,
		const Image &	cIcon
	)

Constructor.

Parameters:

[in]	cGui	Owner GUI
[in]	sText	Text of the menu item
[in]	cIcon	Icon of the menu item

virtual PLGUI_API PLGui::MenuItem::~MenuItem

(

)

[virtual]

Destructor.

PLGUI_API PLGui::MenuItem::MenuItem	(	Gui &	cGui,
		EMenuItemType	nType
	)		[protected]

Constructor.

Parameters:

[in]	cGui	Owner GUI
[in]	nType	Type of menu item

---

Member Function Documentation

PLGUI_API Gui* PLGui::MenuItem::GetGui

(

)

const

Get owner GUI.

Returns:

Pointer to GUI object (never a null pointer)

PLGUI_API EMenuItemType PLGui::MenuItem::GetType

(

)

const

Get type of menu item.

Returns:

Menu item type

PLGUI_API PLCore::uint32 PLGui::MenuItem::GetID

(

)

const

Get command ID.

Returns:

Command ID of the menu item

PLGUI_API void PLGui::MenuItem::SetID

(

PLCore::uint32

nID

)

Set command ID.

Parameters:

[in]

nID

Command ID of the menu item

PLGUI_API PLCore::String PLGui::MenuItem::GetText

(

)

const

Get item text.

Returns:

Text of the menu item

PLGUI_API void PLGui::MenuItem::SetText

(

const PLCore::String &

sText

)

Set item text.

Parameters:

[in]

sText

Text of the menu item

PLGUI_API const Image& PLGui::MenuItem::GetIcon

(

)

const

Get icon.

Returns:

Icon for the menu item

PLGUI_API void PLGui::MenuItem::SetIcon

(

const Image &

cIcon

)

Set icon.

Parameters:

[in]

cIcon

Icon for the menu item

PLGUI_API char PLGui::MenuItem::GetShortcut

(

)

const

Get shortcut of menu item (e.g. if text is "&Test" -> 'T' is the shortcut)

Returns:

Character that can be pressed to select the menu item

---

Member Data Documentation

Gui* PLGui::MenuItem::m_pGui [protected]

Pointer to owner GUI

EMenuItemType PLGui::MenuItem::m_nType [protected]

Menu item type

PLCore::uint32 PLGui::MenuItem::m_nCommandID [protected]

Command ID

PLCore::String PLGui::MenuItem::m_sText [protected]

Text that is displayed

Image PLGui::MenuItem::m_cIcon [protected]

Icon

---

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

• MenuItem.h