1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
<!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::HotkeyMatcher 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="a00047.html">HotkeyMatcher</a></div>
<h1>scim::HotkeyMatcher Class Reference<br>
<small>
[<a class="el" href="a00158.html">Accessories</a>]</small>
</h1><!-- doxytag: class="scim::HotkeyMatcher" -->This class is used to match a <a class="el" href="a00054.html">KeyEvent</a> among a set of hotkeys.
<a href="#_details">More...</a>
<p>
<code>#include <scim_hotkey.h></code>
<p>
<a href="a00365.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="a00047.html#1f5dcfffda5368bd4ae4274e316e96d7">HotkeyMatcher</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#1f5dcfffda5368bd4ae4274e316e96d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#97a939101d6c51a22f32798e9f5ee830">~HotkeyMatcher</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#97a939101d6c51a22f32798e9f5ee830"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#91271f850315972a13e0db3799c1a013">add_hotkey</a> (const <a class="el" href="a00054.html">KeyEvent</a> &key, int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a Hotkey into this <a class="el" href="a00047.html">HotkeyMatcher</a>. <a href="#91271f850315972a13e0db3799c1a013"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#dbc956decc6a8b47a210e15bb0e3ec47">add_hotkeys</a> (const <a class="el" href="a00158.html#gfe3e8c1f1276da4a6331fa96fb1b2398">KeyEventList</a> &keys, int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a set of Hotkeys into this <a class="el" href="a00047.html">HotkeyMatcher</a>. <a href="#dbc956decc6a8b47a210e15bb0e3ec47"></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="a00047.html#a30516ed1aa20b7814dd90ef9716c38e">find_hotkeys</a> (int id, <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 id. <a href="#a30516ed1aa20b7814dd90ef9716c38e"></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="a00047.html#94f33cf978c66166828dc2bb5db6a5a4">get_all_hotkeys</a> (<a class="el" href="a00158.html#gfe3e8c1f1276da4a6331fa96fb1b2398">KeyEventList</a> &keys, std::vector< int > &ids) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get all Hotkeys added into this <a class="el" href="a00047.html">HotkeyMatcher</a>. <a href="#94f33cf978c66166828dc2bb5db6a5a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#0e37c2403af39f0168f9a328f5d6977d">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the <a class="el" href="a00047.html">HotkeyMatcher</a>. <a href="#0e37c2403af39f0168f9a328f5d6977d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#9bcb276e9c4a94173878e38cceb4369d">clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all Hotkeys. <a href="#9bcb276e9c4a94173878e38cceb4369d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#978b78101e8b3590c42a0d33bcd4a5ec">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="#978b78101e8b3590c42a0d33bcd4a5ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#e593cf5c0fa16cd8b1296b9c1f4e7ff0">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="#e593cf5c0fa16cd8b1296b9c1f4e7ff0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#90cc351840bce9439af73702d2061628">get_match_result</a> (void) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the match result. <a href="#90cc351840bce9439af73702d2061628"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class is used to match a <a class="el" href="a00054.html">KeyEvent</a> among a set of hotkeys.
<p>
This class keeps the key event history so that it can match any kind of key events, including key release events, correctly.<p>
If there are large amount of hotkeys to be matched, this class can provide very good performance.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1f5dcfffda5368bd4ae4274e316e96d7"></a><!-- doxytag: member="scim::HotkeyMatcher::HotkeyMatcher" ref="1f5dcfffda5368bd4ae4274e316e96d7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::HotkeyMatcher::HotkeyMatcher </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
</div>
</div><p>
<a class="anchor" name="97a939101d6c51a22f32798e9f5ee830"></a><!-- doxytag: member="scim::HotkeyMatcher::~HotkeyMatcher" ref="97a939101d6c51a22f32798e9f5ee830" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::HotkeyMatcher::~HotkeyMatcher </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="91271f850315972a13e0db3799c1a013"></a><!-- doxytag: member="scim::HotkeyMatcher::add_hotkey" ref="91271f850315972a13e0db3799c1a013" args="(const KeyEvent &key, int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HotkeyMatcher::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">int </td>
<td class="paramname"> <em>id</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 into this <a class="el" href="a00047.html">HotkeyMatcher</a>.
<p>
If a same Hotkey was already added, then it'll be replaced by this new one.<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>A Hotkey to be added. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>An id to be binded to this Hotkey. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="dbc956decc6a8b47a210e15bb0e3ec47"></a><!-- doxytag: member="scim::HotkeyMatcher::add_hotkeys" ref="dbc956decc6a8b47a210e15bb0e3ec47" args="(const KeyEventList &keys, int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HotkeyMatcher::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">int </td>
<td class="paramname"> <em>id</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 into this <a class="el" href="a00047.html">HotkeyMatcher</a>.
<p>
If a same Hotkey in the list was already added, then it'll be replaced by the new one.<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 set of Hotkeys to be added. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>An id to be binded to these Hotkeys. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a30516ed1aa20b7814dd90ef9716c38e"></a><!-- doxytag: member="scim::HotkeyMatcher::find_hotkeys" ref="a30516ed1aa20b7814dd90ef9716c38e" args="(int id, KeyEventList &keys) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t scim::HotkeyMatcher::find_hotkeys </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</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 id.
<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>id</em> </td><td>The id 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 id. </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="94f33cf978c66166828dc2bb5db6a5a4"></a><!-- doxytag: member="scim::HotkeyMatcher::get_all_hotkeys" ref="94f33cf978c66166828dc2bb5db6a5a4" args="(KeyEventList &keys, std::vector< int > &ids) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t scim::HotkeyMatcher::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< int > & </td>
<td class="paramname"> <em>ids</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 added into this <a class="el" href="a00047.html">HotkeyMatcher</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 KeyEventList object to hold all KeyEvents. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ids</em> </td><td>A int list to hold all corresponding IDs.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of available Hotkeys. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0e37c2403af39f0168f9a328f5d6977d"></a><!-- doxytag: member="scim::HotkeyMatcher::reset" ref="0e37c2403af39f0168f9a328f5d6977d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HotkeyMatcher::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="a00047.html">HotkeyMatcher</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="9bcb276e9c4a94173878e38cceb4369d"></a><!-- doxytag: member="scim::HotkeyMatcher::clear" ref="9bcb276e9c4a94173878e38cceb4369d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HotkeyMatcher::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.
<p>
</div>
</div><p>
<a class="anchor" name="978b78101e8b3590c42a0d33bcd4a5ec"></a><!-- doxytag: member="scim::HotkeyMatcher::push_key_event" ref="978b78101e8b3590c42a0d33bcd4a5ec" args="(const KeyEvent &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HotkeyMatcher::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="e593cf5c0fa16cd8b1296b9c1f4e7ff0"></a><!-- doxytag: member="scim::HotkeyMatcher::is_matched" ref="e593cf5c0fa16cd8b1296b9c1f4e7ff0" args="(void) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::HotkeyMatcher::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="90cc351840bce9439af73702d2061628"></a><!-- doxytag: member="scim::HotkeyMatcher::get_match_result" ref="90cc351840bce9439af73702d2061628" args="(void) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int scim::HotkeyMatcher::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 id of the matched Hotkey. If no Hotkey was matched, return -1. </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>
|
