<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>scim: scim::IMEngineHotkeyMatcher Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.0 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="a00157.html">scim</a>::<a class="el" href="a00051.html">IMEngineHotkeyMatcher</a></div>
<h1>scim::IMEngineHotkeyMatcher Class Reference<br>
<small>
[<a class="el" href="a00158.html">Accessories</a>]</small>
</h1><!-- doxytag: class="scim::IMEngineHotkeyMatcher" -->This class hold all Hotkeys for each IMEngines.
<a href="#_details">More...</a>
<p>
<code>#include <scim_hotkey.h></code>
<p>
<a href="a00366.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#1505b3185fb392d08020a8dca85b003d">IMEngineHotkeyMatcher</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#8ae83e63980ef7e415d67b27d58632ae">~IMEngineHotkeyMatcher</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#1a23cd1c1ae254c7f1e33552d14c0933">load_hotkeys</a> (const <a class="el" href="a00070.html">ConfigPointer</a> &config)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load all Hotkeys for IMEngines from Config. <a href="#1a23cd1c1ae254c7f1e33552d14c0933"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#951cb4aea479ef203ae394db9456bcc3">save_hotkeys</a> (const <a class="el" href="a00070.html">ConfigPointer</a> &config) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save all Hotkeys for IMEngines to Config. <a href="#951cb4aea479ef203ae394db9456bcc3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#4d915d1fc468f7df212deb497e47764a">add_hotkey</a> (const <a class="el" href="a00054.html">KeyEvent</a> &key, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a Hotkey for an IMEngine into this <a class="el" href="a00051.html">IMEngineHotkeyMatcher</a>. <a href="#4d915d1fc468f7df212deb497e47764a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#f95f594925a941f18f9a476c781ca269">add_hotkeys</a> (const <a class="el" href="a00158.html#gfe3e8c1f1276da4a6331fa96fb1b2398">KeyEventList</a> &keys, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a set of Hotkeys for an IMEngine into this <a class="el" href="a00051.html">IMEngineHotkeyMatcher</a>. <a href="#f95f594925a941f18f9a476c781ca269"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#d300feafd65a2cc6d179b56c6c07a99f">find_hotkeys</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid, <a class="el" href="a00158.html#gfe3e8c1f1276da4a6331fa96fb1b2398">KeyEventList</a> &keys) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find all Hotkeys binded to a specific IMEngine UUID. <a href="#d300feafd65a2cc6d179b56c6c07a99f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#d20a183de4869391a866997f00de99b6">get_all_hotkeys</a> (<a class="el" href="a00158.html#gfe3e8c1f1276da4a6331fa96fb1b2398">KeyEventList</a> &keys, std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > &uuids) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get all hotkeys in this <a class="el" href="a00051.html">IMEngineHotkeyMatcher</a>. <a href="#d20a183de4869391a866997f00de99b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#de536d4b97dc9a5f3a945c9742a4b44a">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the <a class="el" href="a00051.html">IMEngineHotkeyMatcher</a>. <a href="#de536d4b97dc9a5f3a945c9742a4b44a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#f3a0bcd7fd2801c77d3d1a20f7c38371">clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all Hotkeys and reset the <a class="el" href="a00051.html">IMEngineHotkeyMatcher</a>. <a href="#f3a0bcd7fd2801c77d3d1a20f7c38371"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#199f816583a5e6e73878a68fb0673268">push_key_event</a> (const <a class="el" href="a00054.html">KeyEvent</a> &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Push a <a class="el" href="a00054.html">KeyEvent</a> into the queue. <a href="#199f816583a5e6e73878a68fb0673268"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#d8fb6876c34215ec9e5dbf9e1bd0c194">is_matched</a> (void) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the last <a class="el" href="a00054.html">KeyEvent</a> pushed by push_key_event () matched with any Hotkey. <a href="#d8fb6876c34215ec9e5dbf9e1bd0c194"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00051.html#9cd285eedae33be8aff6fda23ff6f3f6">get_match_result</a> (void) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the match result. <a href="#9cd285eedae33be8aff6fda23ff6f3f6"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class hold all Hotkeys for each IMEngines.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1505b3185fb392d08020a8dca85b003d"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::IMEngineHotkeyMatcher" ref="1505b3185fb392d08020a8dca85b003d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::IMEngineHotkeyMatcher::IMEngineHotkeyMatcher </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="8ae83e63980ef7e415d67b27d58632ae"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::~IMEngineHotkeyMatcher" ref="8ae83e63980ef7e415d67b27d58632ae" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::IMEngineHotkeyMatcher::~IMEngineHotkeyMatcher </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1a23cd1c1ae254c7f1e33552d14c0933"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::load_hotkeys" ref="1a23cd1c1ae254c7f1e33552d14c0933" args="(const ConfigPointer &config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::IMEngineHotkeyMatcher::load_hotkeys </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00070.html">ConfigPointer</a> & </td>
<td class="paramname"> <em>config</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load all Hotkeys for IMEngines from Config.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>The Config object in which the Hotkeys are stored. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="951cb4aea479ef203ae394db9456bcc3"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::save_hotkeys" ref="951cb4aea479ef203ae394db9456bcc3" args="(const ConfigPointer &config) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::IMEngineHotkeyMatcher::save_hotkeys </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00070.html">ConfigPointer</a> & </td>
<td class="paramname"> <em>config</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save all Hotkeys for IMEngines to Config.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>Store all Hotkeys to this Config object. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4d915d1fc468f7df212deb497e47764a"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::add_hotkey" ref="4d915d1fc468f7df212deb497e47764a" args="(const KeyEvent &key, const String &uuid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::IMEngineHotkeyMatcher::add_hotkey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00054.html">KeyEvent</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a Hotkey for an IMEngine into this <a class="el" href="a00051.html">IMEngineHotkeyMatcher</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The Hotkey. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>The UUID of the corresponding IMEngine. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f95f594925a941f18f9a476c781ca269"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::add_hotkeys" ref="f95f594925a941f18f9a476c781ca269" args="(const KeyEventList &keys, const String &uuid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::IMEngineHotkeyMatcher::add_hotkeys </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00158.html#gfe3e8c1f1276da4a6331fa96fb1b2398">KeyEventList</a> & </td>
<td class="paramname"> <em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a set of Hotkeys for an IMEngine into this <a class="el" href="a00051.html">IMEngineHotkeyMatcher</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keys</em> </td><td>The Hotkeys. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>The UUID of the corresponding IMEngine. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d300feafd65a2cc6d179b56c6c07a99f"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::find_hotkeys" ref="d300feafd65a2cc6d179b56c6c07a99f" args="(const String &uuid, KeyEventList &keys) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t scim::IMEngineHotkeyMatcher::find_hotkeys </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00158.html#gfe3e8c1f1276da4a6331fa96fb1b2398">KeyEventList</a> & </td>
<td class="paramname"> <em>keys</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find all Hotkeys binded to a specific IMEngine UUID.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>The IMEngine uuid to be found. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keys</em> </td><td>A KeyEventList object to hold all KeyEvents binded to the uuid. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of Hotkeys found. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d20a183de4869391a866997f00de99b6"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::get_all_hotkeys" ref="d20a183de4869391a866997f00de99b6" args="(KeyEventList &keys, std::vector< String > &uuids) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t scim::IMEngineHotkeyMatcher::get_all_hotkeys </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00158.html#gfe3e8c1f1276da4a6331fa96fb1b2398">KeyEventList</a> & </td>
<td class="paramname"> <em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > & </td>
<td class="paramname"> <em>uuids</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get all hotkeys in this <a class="el" href="a00051.html">IMEngineHotkeyMatcher</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keys</em> </td><td>A list of all Hotkeys. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>uuids</em> </td><td>A list of all corresponding IMEngine UUIDs. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of hotkeys found. </dd></dl>
</div>
</div><p>
<a class="anchor" name="de536d4b97dc9a5f3a945c9742a4b44a"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::reset" ref="de536d4b97dc9a5f3a945c9742a4b44a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::IMEngineHotkeyMatcher::reset </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset the <a class="el" href="a00051.html">IMEngineHotkeyMatcher</a>.
<p>
The <a class="el" href="a00054.html">KeyEvent</a> queue will be cleared, all state will be reset. The Hotkeys which were already added will not be touched.
</div>
</div><p>
<a class="anchor" name="f3a0bcd7fd2801c77d3d1a20f7c38371"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::clear" ref="f3a0bcd7fd2801c77d3d1a20f7c38371" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::IMEngineHotkeyMatcher::clear </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear all Hotkeys and reset the <a class="el" href="a00051.html">IMEngineHotkeyMatcher</a>.
<p>
</div>
</div><p>
<a class="anchor" name="199f816583a5e6e73878a68fb0673268"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::push_key_event" ref="199f816583a5e6e73878a68fb0673268" args="(const KeyEvent &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::IMEngineHotkeyMatcher::push_key_event </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00054.html">KeyEvent</a> & </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Push a <a class="el" href="a00054.html">KeyEvent</a> into the queue.
<p>
This <a class="el" href="a00054.html">KeyEvent</a> will be matched against the available Hotkeys immediately.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key to be pushed into. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d8fb6876c34215ec9e5dbf9e1bd0c194"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::is_matched" ref="d8fb6876c34215ec9e5dbf9e1bd0c194" args="(void) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::IMEngineHotkeyMatcher::is_matched </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the last <a class="el" href="a00054.html">KeyEvent</a> pushed by push_key_event () matched with any Hotkey.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true If the <a class="el" href="a00054.html">KeyEvent</a> matched with a Hotkey. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9cd285eedae33be8aff6fda23ff6f3f6"></a><!-- doxytag: member="scim::IMEngineHotkeyMatcher::get_match_result" ref="9cd285eedae33be8aff6fda23ff6f3f6" args="(void) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::IMEngineHotkeyMatcher::get_match_result </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the match result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The corresponding UUID of the matched Hotkey. If no Hotkey was matched, return null string. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00134.html">scim_hotkey.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:39 2007 for scim by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
3c9265ee0944a35fbede43df6ed55872
>
files
>
110
