This class hold all FrontEnd specific Hotkeys, such as trigger keys, on/off keys, etc.
More...
#include <scim_hotkey.h>
List of all members.
Detailed Description
This class hold all FrontEnd specific Hotkeys, such as trigger keys, on/off keys, etc.
Constructor & Destructor Documentation
scim::FrontEndHotkeyMatcher::FrontEndHotkeyMatcher |
( |
|
) |
|
scim::FrontEndHotkeyMatcher::~FrontEndHotkeyMatcher |
( |
|
) |
|
Member Function Documentation
void scim::FrontEndHotkeyMatcher::load_hotkeys |
( |
const ConfigPointer & |
config |
) |
|
Load all FrontEnd specific Hotkeys from Config.
- Parameters:
-
| config | The Config object in which the Hotkeys are stored. |
void scim::FrontEndHotkeyMatcher::save_hotkeys |
( |
const ConfigPointer & |
config |
) |
const |
Save all FrontEnd specific Hotkeys to Config.
- Parameters:
-
| config | Store all Hotkeys to this Config object. |
Add a Hotkey for an FrontEnd into this FrontEndHotkeyMatcher.
- Parameters:
-
| key | The Hotkey. |
| action | The action to do when the hotkey is matched. |
Add a set of Hotkeys for an FrontEnd into this FrontEndHotkeyMatcher.
- Parameters:
-
| keys | The Hotkeys. |
| action | The action to do when the hotkey is matched. |
Find all Hotkeys binded to a specific action.
- Parameters:
-
| action | The action to be found. |
| keys | A KeyEventList object to hold all KeyEvents binded to the action. |
- Returns:
- The number of Hotkeys found.
Get all hotkeys in this FrontEndHotkeyMatcher.
- Parameters:
-
| keys | A list of all Hotkeys. |
| actions | A list of all corresponding actions |
void scim::FrontEndHotkeyMatcher::reset |
( |
void |
|
) |
|
Reset the FrontEndHotkeyMatcher.
The KeyEvent queue will be cleared, all state will be reset. The Hotkeys which were already added will not be touched.
void scim::FrontEndHotkeyMatcher::clear |
( |
void |
|
) |
|
void scim::FrontEndHotkeyMatcher::push_key_event |
( |
const KeyEvent & |
key |
) |
|
Push a KeyEvent into the queue.
This KeyEvent will be matched against the available Hotkeys immediately.
- Parameters:
-
| key | The key to be pushed into. |
bool scim::FrontEndHotkeyMatcher::is_matched |
( |
void |
|
) |
const |
Check if the last KeyEvent pushed by push_key_event () matched with any Hotkey.
- Returns:
- true If the KeyEvent matched with a Hotkey.
Get the match result.
- Returns:
- The corresponding action of the matched Hotkey.
The documentation for this class was generated from the following file: