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
397
398
399
400
401
402
403
404
405
|
<!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::ComposeKeyInstance 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="a00013.html">ComposeKeyInstance</a></div>
<h1>scim::ComposeKeyInstance Class Reference<br>
<small>
[<a class="el" href="a00160.html">IMEngine</a>]</small>
</h1><!-- doxytag: class="scim::ComposeKeyInstance" --><!-- doxytag: inherits="scim::IMEngineInstanceBase" --><code>#include <scim_compose_key.h></code>
<p>
Inheritance diagram for scim::ComposeKeyInstance:<p><center><img src="a00287.png" border="0" usemap="#a00288" alt="Inheritance graph"></center>
<map name="a00288">
<area href="a00052.html" shape="rect" coords="7,83,204,107" alt="">
<area href="a00072.html" shape="rect" coords="20,8,191,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for scim::ComposeKeyInstance:<p><center><img src="a00289.png" border="0" usemap="#a00290" alt="Collaboration graph"></center>
<map name="a00290">
<area href="a00052.html" shape="rect" coords="7,83,204,107" alt="">
<area href="a00072.html" shape="rect" coords="20,8,191,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="a00291.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="a00013.html#9a74facc0c0732dbb42d1b98d0ca7420">ComposeKeyInstance</a> (<a class="el" href="a00012.html">ComposeKeyFactory</a> *factory, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding, int id=-1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#07e5f69a1341647f3c73ad8739313b57">~ComposeKeyInstance</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#612121cd8af64dfc92b7e53be3636ade">process_key_event</a> (const <a class="el" href="a00054.html">KeyEvent</a> &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Process a key event. <a href="#612121cd8af64dfc92b7e53be3636ade"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#d9b63c69d86fb58a1f6ec8ab9ce83130">move_preedit_caret</a> (unsigned int pos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the preedit caret in the preedit string. <a href="#d9b63c69d86fb58a1f6ec8ab9ce83130"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#2e18005dbe0f4e6cf996fe85dd9d14e8">select_candidate</a> (unsigned int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select a candidate in current lookup table. <a href="#2e18005dbe0f4e6cf996fe85dd9d14e8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#de80bef3dfcd1010934661adb558ea13">update_lookup_table_page_size</a> (unsigned int page_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the page size of current lookup table. <a href="#de80bef3dfcd1010934661adb558ea13"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#7bcabbab7ff98fc2da3546991aa4e617">lookup_table_page_up</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flip the lookup table to the previous page. <a href="#7bcabbab7ff98fc2da3546991aa4e617"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#890483f519b780b29cec84f05587e49e">lookup_table_page_down</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flip the lookup table to the next page. <a href="#890483f519b780b29cec84f05587e49e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#3a1406a0a72350026600016c5bb4b306">reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset this engine instance. <a href="#3a1406a0a72350026600016c5bb4b306"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#9e50118343446a8ceeba6188b899a374">focus_in</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Focus in this engine instance. <a href="#9e50118343446a8ceeba6188b899a374"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#7cc0279c4638ef0f0d885fe542c904d1">focus_out</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Focus out this engine instance. <a href="#7cc0279c4638ef0f0d885fe542c904d1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html#d6b4897a3b05f70e53f9fb32401120ea">trigger_property</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Trigger a property. <a href="#d6b4897a3b05f70e53f9fb32401120ea"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9a74facc0c0732dbb42d1b98d0ca7420"></a><!-- doxytag: member="scim::ComposeKeyInstance::ComposeKeyInstance" ref="9a74facc0c0732dbb42d1b98d0ca7420" args="(ComposeKeyFactory *factory, const String &encoding, int id=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::ComposeKeyInstance::ComposeKeyInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00012.html">ComposeKeyFactory</a> * </td>
<td class="paramname"> <em>factory</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>encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> = <code>-1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="07e5f69a1341647f3c73ad8739313b57"></a><!-- doxytag: member="scim::ComposeKeyInstance::~ComposeKeyInstance" ref="07e5f69a1341647f3c73ad8739313b57" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual scim::ComposeKeyInstance::~ComposeKeyInstance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="612121cd8af64dfc92b7e53be3636ade"></a><!-- doxytag: member="scim::ComposeKeyInstance::process_key_event" ref="612121cd8af64dfc92b7e53be3636ade" args="(const KeyEvent &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ComposeKeyInstance::process_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%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process a key event.
<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 event to be processed. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the event is processed, otherwise the event is not processed and should be forward to client application. </dd></dl>
<p>
Implements <a class="el" href="a00052.html#a2da7c8755e6af90cc8dfe2a5d47bcec">scim::IMEngineInstanceBase</a>.
</div>
</div><p>
<a class="anchor" name="d9b63c69d86fb58a1f6ec8ab9ce83130"></a><!-- doxytag: member="scim::ComposeKeyInstance::move_preedit_caret" ref="d9b63c69d86fb58a1f6ec8ab9ce83130" args="(unsigned int pos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::ComposeKeyInstance::move_preedit_caret </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>pos</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Move the preedit caret in the preedit string.
<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>pos</em> </td><td>- the new position that user requested. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="a00052.html#84bd207c8d6959c8fcc61a630ab61b59">scim::IMEngineInstanceBase</a>.
</div>
</div><p>
<a class="anchor" name="2e18005dbe0f4e6cf996fe85dd9d14e8"></a><!-- doxytag: member="scim::ComposeKeyInstance::select_candidate" ref="2e18005dbe0f4e6cf996fe85dd9d14e8" args="(unsigned int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::ComposeKeyInstance::select_candidate </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Select a candidate in current lookup table.
<p>
When user click a candidate directly, this method will be invoked by FrontEnd.<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>index</em> </td><td>- the index in current page of the selected candidate. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="a00052.html#f8af093dae67b196416bf0099298dfc3">scim::IMEngineInstanceBase</a>.
</div>
</div><p>
<a class="anchor" name="de80bef3dfcd1010934661adb558ea13"></a><!-- doxytag: member="scim::ComposeKeyInstance::update_lookup_table_page_size" ref="de80bef3dfcd1010934661adb558ea13" args="(unsigned int page_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::ComposeKeyInstance::update_lookup_table_page_size </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>page_size</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the page size of current lookup table.
<p>
In the next time, the lookup table should page down by this size.<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>page_size</em> </td><td>- the new size of current page. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="a00052.html#a62ab13f71a146cdaaee1e33c671b3c7">scim::IMEngineInstanceBase</a>.
</div>
</div><p>
<a class="anchor" name="7bcabbab7ff98fc2da3546991aa4e617"></a><!-- doxytag: member="scim::ComposeKeyInstance::lookup_table_page_up" ref="7bcabbab7ff98fc2da3546991aa4e617" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::ComposeKeyInstance::lookup_table_page_up </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flip the lookup table to the previous page.
<p>
The method will be invoked by FrontEnd when user click the lookup table page up button.
<p>
Reimplemented from <a class="el" href="a00052.html#244f2132661b86d5b7232e3fee20ce74">scim::IMEngineInstanceBase</a>.
</div>
</div><p>
<a class="anchor" name="890483f519b780b29cec84f05587e49e"></a><!-- doxytag: member="scim::ComposeKeyInstance::lookup_table_page_down" ref="890483f519b780b29cec84f05587e49e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::ComposeKeyInstance::lookup_table_page_down </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flip the lookup table to the next page.
<p>
The method will be invoked by FrontEnd when user click the lookup table page down button.
<p>
Reimplemented from <a class="el" href="a00052.html#4b460876bc485b2a636ff4a6c1ef951b">scim::IMEngineInstanceBase</a>.
</div>
</div><p>
<a class="anchor" name="3a1406a0a72350026600016c5bb4b306"></a><!-- doxytag: member="scim::ComposeKeyInstance::reset" ref="3a1406a0a72350026600016c5bb4b306" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::ComposeKeyInstance::reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset this engine instance.
<p>
All status of this engine instance should be reset, including the working encoding.<p>
The client encoding may have been changed before calling this method, so if the IMEngine makes use of the client's encoding information, it should check whether the encoding has been changed. IMEngineInstance could call the get_encoding () method of base class to get the client encoding.
<p>
Reimplemented from <a class="el" href="a00052.html#cdc4f433def9d043eecb879061a8eb70">scim::IMEngineInstanceBase</a>.
</div>
</div><p>
<a class="anchor" name="9e50118343446a8ceeba6188b899a374"></a><!-- doxytag: member="scim::ComposeKeyInstance::focus_in" ref="9e50118343446a8ceeba6188b899a374" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::ComposeKeyInstance::focus_in </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Focus in this engine instance.
<p>
This function should update/show/hide the status area, preedit area and lookup table, and update the full width punctuation/letter state.
<p>
Reimplemented from <a class="el" href="a00052.html#44db147dc9892194c190efb6958a523d">scim::IMEngineInstanceBase</a>.
</div>
</div><p>
<a class="anchor" name="7cc0279c4638ef0f0d885fe542c904d1"></a><!-- doxytag: member="scim::ComposeKeyInstance::focus_out" ref="7cc0279c4638ef0f0d885fe542c904d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::ComposeKeyInstance::focus_out </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Focus out this engine instance.
<p>
<p>
Reimplemented from <a class="el" href="a00052.html#e4488970b00d61456035ed59edab9037">scim::IMEngineInstanceBase</a>.
</div>
</div><p>
<a class="anchor" name="d6b4897a3b05f70e53f9fb32401120ea"></a><!-- doxytag: member="scim::ComposeKeyInstance::trigger_property" ref="d6b4897a3b05f70e53f9fb32401120ea" args="(const String &property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::ComposeKeyInstance::trigger_property </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>property</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Trigger a property.
<p>
This function should do some action according to the triggered property. For example toggle the input mode, etc.<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>property</em> </td><td>the key of the triggered property. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="a00052.html#07356c4e5fc2b563aae2a927ee284512">scim::IMEngineInstanceBase</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00116.html">scim_compose_key.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:37 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>
|
