scim  1.4.9
scim::FrontEndHotkeyMatcher Class Reference

This class hold all FrontEnd specific Hotkeys, such as trigger keys, on/off keys, etc. More...

#include <scim_hotkey.h>

List of all members.

Public Member Functions

 FrontEndHotkeyMatcher ()
 ~FrontEndHotkeyMatcher ()
void load_hotkeys (const ConfigPointer &config)
 Load all FrontEnd specific Hotkeys from Config.
void save_hotkeys (const ConfigPointer &config) const
 Save all FrontEnd specific Hotkeys to Config.
void add_hotkey (const KeyEvent &key, FrontEndHotkeyAction action)
 Add a Hotkey for an FrontEnd into this FrontEndHotkeyMatcher.
void add_hotkeys (const KeyEventList &keys, FrontEndHotkeyAction action)
 Add a set of Hotkeys for an FrontEnd into this FrontEndHotkeyMatcher.
size_t find_hotkeys (FrontEndHotkeyAction action, KeyEventList &keys) const
 Find all Hotkeys binded to a specific action.
size_t get_all_hotkeys (KeyEventList &keys, std::vector< FrontEndHotkeyAction > &actions) const
 Get all hotkeys in this FrontEndHotkeyMatcher.
void reset (void)
 Reset the FrontEndHotkeyMatcher.
void clear (void)
 Clear all Hotkeys and reset the FrontEndHotkeyMatcher.
void push_key_event (const KeyEvent &key)
 Push a KeyEvent into the queue.
bool is_matched (void) const
 Check if the last KeyEvent pushed by push_key_event () matched with any Hotkey.
FrontEndHotkeyAction get_match_result (void) const
 Get the match result.

Detailed Description

This class hold all FrontEnd specific Hotkeys, such as trigger keys, on/off keys, etc.


Constructor & Destructor Documentation

scim::FrontEndHotkeyMatcher::FrontEndHotkeyMatcher ( )

Member Function Documentation

Load all FrontEnd specific Hotkeys from Config.

Parameters:
configThe Config object in which the Hotkeys are stored.

Save all FrontEnd specific Hotkeys to Config.

Parameters:
configStore all Hotkeys to this Config object.

Add a Hotkey for an FrontEnd into this FrontEndHotkeyMatcher.

Parameters:
keyThe Hotkey.
actionThe action to do when the hotkey is matched.

Add a set of Hotkeys for an FrontEnd into this FrontEndHotkeyMatcher.

Parameters:
keysThe Hotkeys.
actionThe action to do when the hotkey is matched.

Find all Hotkeys binded to a specific action.

Parameters:
actionThe action to be found.
keysA KeyEventList object to hold all KeyEvents binded to the action.
Returns:
The number of Hotkeys found.
size_t scim::FrontEndHotkeyMatcher::get_all_hotkeys ( KeyEventList keys,
std::vector< FrontEndHotkeyAction > &  actions 
) const

Get all hotkeys in this FrontEndHotkeyMatcher.

Parameters:
keysA list of all Hotkeys.
actionsA list of all corresponding actions

Reset the FrontEndHotkeyMatcher.

The KeyEvent queue will be cleared, all state will be reset. The Hotkeys which were already added will not be touched.

Clear all Hotkeys and reset the FrontEndHotkeyMatcher.

Push a KeyEvent into the queue.

This KeyEvent will be matched against the available Hotkeys immediately.

Parameters:
keyThe key to be pushed into.

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: