scim  1.4.13
scim::IMEngineHotkeyMatcher Class Reference

This class hold all Hotkeys for each IMEngines. More...

#include <scim_hotkey.h>

List of all members.

Public Member Functions

 IMEngineHotkeyMatcher ()
 ~IMEngineHotkeyMatcher ()
void load_hotkeys (const ConfigPointer &config)
 Load all Hotkeys for IMEngines from Config.
void save_hotkeys (const ConfigPointer &config) const
 Save all Hotkeys for IMEngines to Config.
void add_hotkey (const KeyEvent &key, const String &uuid)
 Add a Hotkey for an IMEngine into this IMEngineHotkeyMatcher.
void add_hotkeys (const KeyEventList &keys, const String &uuid)
 Add a set of Hotkeys for an IMEngine into this IMEngineHotkeyMatcher.
size_t find_hotkeys (const String &uuid, KeyEventList &keys) const
 Find all Hotkeys binded to a specific IMEngine UUID.
size_t get_all_hotkeys (KeyEventList &keys, std::vector< String > &uuids) const
 Get all hotkeys in this IMEngineHotkeyMatcher.
void reset (void)
 Reset the IMEngineHotkeyMatcher.
void clear (void)
 Clear all Hotkeys and reset the IMEngineHotkeyMatcher.
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.
String get_match_result (void) const
 Get the match result.

Detailed Description

This class hold all Hotkeys for each IMEngines.


Constructor & Destructor Documentation

scim::IMEngineHotkeyMatcher::IMEngineHotkeyMatcher ( )
scim::IMEngineHotkeyMatcher::~IMEngineHotkeyMatcher ( )

Member Function Documentation

void scim::IMEngineHotkeyMatcher::load_hotkeys ( const ConfigPointer config)

Load all Hotkeys for IMEngines from Config.

Parameters:
configThe Config object in which the Hotkeys are stored.
void scim::IMEngineHotkeyMatcher::save_hotkeys ( const ConfigPointer config) const

Save all Hotkeys for IMEngines to Config.

Parameters:
configStore all Hotkeys to this Config object.
void scim::IMEngineHotkeyMatcher::add_hotkey ( const KeyEvent key,
const String uuid 
)

Add a Hotkey for an IMEngine into this IMEngineHotkeyMatcher.

Parameters:
keyThe Hotkey.
uuidThe UUID of the corresponding IMEngine.
void scim::IMEngineHotkeyMatcher::add_hotkeys ( const KeyEventList keys,
const String uuid 
)

Add a set of Hotkeys for an IMEngine into this IMEngineHotkeyMatcher.

Parameters:
keysThe Hotkeys.
uuidThe UUID of the corresponding IMEngine.
size_t scim::IMEngineHotkeyMatcher::find_hotkeys ( const String uuid,
KeyEventList keys 
) const

Find all Hotkeys binded to a specific IMEngine UUID.

Parameters:
uuidThe IMEngine uuid to be found.
keysA KeyEventList object to hold all KeyEvents binded to the uuid.
Returns:
The number of Hotkeys found.
size_t scim::IMEngineHotkeyMatcher::get_all_hotkeys ( KeyEventList keys,
std::vector< String > &  uuids 
) const

Get all hotkeys in this IMEngineHotkeyMatcher.

Parameters:
keysA list of all Hotkeys.
uuidsA list of all corresponding IMEngine UUIDs.
Returns:
the number of hotkeys found.
void scim::IMEngineHotkeyMatcher::reset ( void  )

Reset the IMEngineHotkeyMatcher.

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

void scim::IMEngineHotkeyMatcher::clear ( void  )

Clear all Hotkeys and reset the IMEngineHotkeyMatcher.

void scim::IMEngineHotkeyMatcher::push_key_event ( const KeyEvent key)

Push a KeyEvent into the queue.

This KeyEvent will be matched against the available Hotkeys immediately.

Parameters:
keyThe key to be pushed into.
bool scim::IMEngineHotkeyMatcher::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.
String scim::IMEngineHotkeyMatcher::get_match_result ( void  ) const

Get the match result.

Returns:
The corresponding UUID of the matched Hotkey. If no Hotkey was matched, return null string.

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