HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UI_HotkeyHelper Class Reference

#include <UI_HotkeyHelper.h>

Classes

struct  Entry
 

Public Member Functions

 UI_HotkeyHelper (UI_Object *client)
 Default constructor. More...
 
 UI_HotkeyHelper (UI_Object *client, const Entry *hotkey_entries)
 Construct using an array of hotkey entries terminated by NULL mySymbol. More...
 
virtual ~UI_HotkeyHelper ()
 Destructor. More...
 
void addHotkeys (const Entry *hotkey_entries)
 Adds an array of hotkey entries terminated by NULL mySymbol. More...
 
void addHotkey (const Entry &entry)
 Add a single hotkey entry. More...
 
void removeHotkey (const char *symbol)
 Remove a hotkey entry. More...
 
bool processHotkey (UI_Event *event)
 
bool willProcessHotkey (UI_Event *event)
 Will we handle the given UI hotkey symbol? More...
 

Detailed Description

The UI_HotkeyHelper class allows one to maintain a table of hotkeys and their associated handler functions (of type UI_HotkeyMethod) so that we can easily perform functions like dispatching hotkey handlers as well as testing to see if a hotkey is going to be handled without invoking the handler.

Definition at line 30 of file UI_HotkeyHelper.h.

Constructor & Destructor Documentation

UI_HotkeyHelper::UI_HotkeyHelper ( UI_Object client)

Default constructor.

UI_HotkeyHelper::UI_HotkeyHelper ( UI_Object client,
const Entry hotkey_entries 
)

Construct using an array of hotkey entries terminated by NULL mySymbol.

virtual UI_HotkeyHelper::~UI_HotkeyHelper ( )
virtual

Destructor.

Member Function Documentation

void UI_HotkeyHelper::addHotkey ( const Entry entry)

Add a single hotkey entry.

void UI_HotkeyHelper::addHotkeys ( const Entry hotkey_entries)

Adds an array of hotkey entries terminated by NULL mySymbol.

bool UI_HotkeyHelper::processHotkey ( UI_Event event)

Invoke the handler for the given UI hotkey event. Returns true if consumed, false otherwise.

void UI_HotkeyHelper::removeHotkey ( const char *  symbol)

Remove a hotkey entry.

bool UI_HotkeyHelper::willProcessHotkey ( UI_Event event)

Will we handle the given UI hotkey symbol?


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