MGUI::HOTKEYSET Class Reference

#include <mgui/hotkeyset.h>

List of all members.

Public Types
typedef FastDelegate< void(KEYCODE, KEYSTATE, const POINT &)>	DELEGATE
Public Member Functions
	HOTKEYSET (const HOTKEYSET &rhs)
	HOTKEYSET ()
	~HOTKEYSET ()
bool	Add (const HOTKEYSET &HotKeySet)
bool	Add (KEYCODE KeyCode, DELEGATE HotKeyDelegate, KEYSTATE KeyState=KEYSTATE_None)
bool	CallDelegate (KEYCODE KeyCode, KEYSTATE KeyState, const POINT &Point) const
bool	IsEmpty () const
HOTKEYSET &	operator= (const HOTKEYSET &rhs)
bool	Remove (const HOTKEYSET &HotKeySet)
bool	Remove (KEYCODE KeyCode, DELEGATE HotKeyDelegate, KEYSTATE KeyState=KEYSTATE_None)

---

Member Typedef Documentation

typedef FastDelegate<void(KEYCODE, KEYSTATE, const POINT&)> MGUI::HOTKEYSET::DELEGATE

---

Constructor & Destructor Documentation

MGUI::HOTKEYSET::HOTKEYSET

(

)

Default ctor.

MGUI::HOTKEYSET::HOTKEYSET

(

const HOTKEYSET &

rhs

)

Default copy ctor.

MGUI::HOTKEYSET::~HOTKEYSET

(

)

Destructor.

---

Member Function Documentation

bool MGUI::HOTKEYSET::Add

(

const HOTKEYSET &

HotKeySet

)

Add another HOTKEYSET to this set.

Returns:

'True' if all hot key entries added, 'false' if there is one or more keys that match.

bool MGUI::HOTKEYSET::Add	(	KEYCODE	KeyCode,
		DELEGATE	HotKeyDelegate,
		KEYSTATE	KeyState = KEYSTATE_None
	)

Add a hot key and a delegate to call to this set of hot keys.

Returns:

'True' if hot key entry added, 'false' if one already exists

bool MGUI::HOTKEYSET::CallDelegate	(	KEYCODE	KeyCode,
		KEYSTATE	KeyState,
		const POINT &	Point
	)			const

Find the entry in this set based on the KeyCode and KeyStsate and call the delegate associated with it.

Returns:

'True' if entry is found and delegate called, 'false' if entry not found.

Parameters:

Point

Point where the mouse was located in the MGUI::CTRL or MGUI::SHELL the hot key was pressed

bool MGUI::HOTKEYSET::IsEmpty

(

)

const [inline]

Determine if this set of hot keys is empty.

Returns:

'True' if set is empty, 'false' if not.

HOTKEYSET& MGUI::HOTKEYSET::operator=

(

const HOTKEYSET &

rhs

)

Assignment operator.

bool MGUI::HOTKEYSET::Remove

(

const HOTKEYSET &

HotKeySet

)

Add a set of hot key's from this set.

An entry must match all three parameters in the single Remove() method listed above.

Returns:

'True' if all hot key entries removed, 'false' if there is one or more keys that does not match

bool MGUI::HOTKEYSET::Remove	(	KEYCODE	KeyCode,
		DELEGATE	HotKeyDelegate,
		KEYSTATE	KeyState = KEYSTATE_None
	)

Remove a hot key entry, must match all three parameters.

Returns:

'True' if hot key entry removed, 'false' if did not exist in set.

---

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

• mgui/hotkeyset.h