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
|
<!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::DummyIMEngineFactory 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="a00022.html">DummyIMEngineFactory</a></div>
<h1>scim::DummyIMEngineFactory Class Reference<br>
<small>
[<a class="el" href="a00160.html">IMEngine</a>]</small>
</h1><!-- doxytag: class="scim::DummyIMEngineFactory" --><!-- doxytag: inherits="scim::IMEngineFactoryBase" -->A trivial IMEngine that do nothing.
<a href="#_details">More...</a>
<p>
<code>#include <scim_imengine.h></code>
<p>
Inheritance diagram for scim::DummyIMEngineFactory:<p><center><img src="a00384.png" border="0" usemap="#a00385" alt="Inheritance graph"></center>
<map name="a00385">
<area href="a00050.html" shape="rect" coords="11,83,200,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::DummyIMEngineFactory:<p><center><img src="a00386.png" border="0" usemap="#a00387" alt="Collaboration graph"></center>
<map name="a00387">
<area href="a00050.html" shape="rect" coords="11,83,200,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="a00388.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="a00022.html#9bd77bfc09348ffbe9ed8f1f2a526eba">DummyIMEngineFactory</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#276eb3c3f760e0e40b348d6a0c837e5f">~DummyIMEngineFactory</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#bf5ea1bc138b387a4856bb92ca854d1a">get_name</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of this input method engine. <a href="#bf5ea1bc138b387a4856bb92ca854d1a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#c181f2ba3e9382c95f23c0c1b5465242">get_uuid</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the UUID of this input method engine. <a href="#c181f2ba3e9382c95f23c0c1b5465242"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#79ed41a0a226ea323fcc261910146907">get_icon_file</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the icon file path of this input method engine. <a href="#79ed41a0a226ea323fcc261910146907"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#851319dfef054efc613470b1e2eeb160">get_authors</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the authors information of this input method engine. <a href="#851319dfef054efc613470b1e2eeb160"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#8a57437e32167d97cefb84b403e398f9">get_credits</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the credits information of this input method engine. <a href="#8a57437e32167d97cefb84b403e398f9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#e5e52b19003d7c6583249ee4cbb558c1">get_help</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the help information of this input method engine. <a href="#e5e52b19003d7c6583249ee4cbb558c1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#15ac2a739fa20285032faac0a16b6a05">validate_encoding</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if an encoding is supported by this IMEngineFactory. <a href="#15ac2a739fa20285032faac0a16b6a05"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#798b986e7006bb368b3252cf8855898e">validate_locale</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &locale) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a locale is supported by this IMEngineFactory. <a href="#798b986e7006bb368b3252cf8855898e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00070.html">IMEngineInstancePointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#9aa887267c901bb8be1b29466a1ed47c">create_instance</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding, int id=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new IMEngineInstance object. <a href="#9aa887267c901bb8be1b29466a1ed47c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A trivial IMEngine that do nothing.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9bd77bfc09348ffbe9ed8f1f2a526eba"></a><!-- doxytag: member="scim::DummyIMEngineFactory::DummyIMEngineFactory" ref="9bd77bfc09348ffbe9ed8f1f2a526eba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::DummyIMEngineFactory::DummyIMEngineFactory </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="276eb3c3f760e0e40b348d6a0c837e5f"></a><!-- doxytag: member="scim::DummyIMEngineFactory::~DummyIMEngineFactory" ref="276eb3c3f760e0e40b348d6a0c837e5f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual scim::DummyIMEngineFactory::~DummyIMEngineFactory </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="bf5ea1bc138b387a4856bb92ca854d1a"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_name" ref="bf5ea1bc138b387a4856bb92ca854d1a" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::DummyIMEngineFactory::get_name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of this input method engine.
<p>
This name should be a localized string.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A WideString containing the name. </dd></dl>
<p>
Implements <a class="el" href="a00050.html#20d91317ff7c2cc60725210049e705ea">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="c181f2ba3e9382c95f23c0c1b5465242"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_uuid" ref="c181f2ba3e9382c95f23c0c1b5465242" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::DummyIMEngineFactory::get_uuid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the UUID of this input method engine.
<p>
Each input method engine has an unique UUID to distinguish itself from other engines.<p>
You may use uuidgen command shipped with e2fsprogs package to generate this UUID.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A String containing an unique UUID. </dd></dl>
<p>
Implements <a class="el" href="a00050.html#189ce916ba791abcf6c2553d8ebc11e0">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="79ed41a0a226ea323fcc261910146907"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_icon_file" ref="79ed41a0a226ea323fcc261910146907" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::DummyIMEngineFactory::get_icon_file </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the icon file path of this input method engine.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A String containing the icon file path on the local filesystem. </dd></dl>
<p>
Implements <a class="el" href="a00050.html#f22c5cce4801400553d0686d58da3e9e">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="851319dfef054efc613470b1e2eeb160"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_authors" ref="851319dfef054efc613470b1e2eeb160" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::DummyIMEngineFactory::get_authors </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the authors information of this input method engine.
<p>
This string should be a localized string.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A WideString containing a list of the authors' name. </dd></dl>
<p>
Implements <a class="el" href="a00050.html#4874af640b799b0feb602d43fb016d22">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="8a57437e32167d97cefb84b403e398f9"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_credits" ref="8a57437e32167d97cefb84b403e398f9" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::DummyIMEngineFactory::get_credits </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the credits information of this input method engine.
<p>
This string should be a localized string.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A WideString containing the credits information. </dd></dl>
<p>
Implements <a class="el" href="a00050.html#80b752a4058c0a7866f0d772bd9193d6">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="e5e52b19003d7c6583249ee4cbb558c1"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_help" ref="e5e52b19003d7c6583249ee4cbb558c1" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::DummyIMEngineFactory::get_help </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the help information of this input method engine.
<p>
This string should be a localized string.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A WideString containing the help information. </dd></dl>
<p>
Implements <a class="el" href="a00050.html#aa4f1d3099956c7d7795df62aa0811f2">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="15ac2a739fa20285032faac0a16b6a05"></a><!-- doxytag: member="scim::DummyIMEngineFactory::validate_encoding" ref="15ac2a739fa20285032faac0a16b6a05" args="(const String &encoding) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::DummyIMEngineFactory::validate_encoding </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>encoding</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if an encoding is supported by this IMEngineFactory.
<p>
The default implementation of this virtual function validates the encoding against the locale list set by method set_locales.<p>
It should be enough in most case.<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>encoding</em> </td><td>- the encoding name to be checked. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the encoding is supported, otherwise false. </dd></dl>
<p>
Reimplemented from <a class="el" href="a00050.html#8149111b68c2b10a515a307b7476ae6c">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="798b986e7006bb368b3252cf8855898e"></a><!-- doxytag: member="scim::DummyIMEngineFactory::validate_locale" ref="798b986e7006bb368b3252cf8855898e" args="(const String &locale) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::DummyIMEngineFactory::validate_locale </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>locale</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a locale is supported by this IMEngineFactory.
<p>
The default implementation of this virtual function validates the locale against the locale list set by method set_locales.<p>
It should be enough in most case.<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>locale</em> </td><td>- the locale name to be checked. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the locale is supported, otherwise false. </dd></dl>
<p>
Reimplemented from <a class="el" href="a00050.html#f9ca6ba3bcff44112df84cd98b02c88f">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="9aa887267c901bb8be1b29466a1ed47c"></a><!-- doxytag: member="scim::DummyIMEngineFactory::create_instance" ref="9aa887267c901bb8be1b29466a1ed47c" args="(const String &encoding, int id=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00070.html">IMEngineInstancePointer</a> scim::DummyIMEngineFactory::create_instance </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%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a new IMEngineInstance object.
<p>
This method creates a new <a class="el" href="a00052.html">scim::IMEngineInstanceBase</a> object with the given encoding and 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>encoding</em> </td><td>- the encoding supported by the client. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>- the instance id, should be unique. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A smart pointer points to this new IMEngineInstance object. </dd></dl>
<p>
Implements <a class="el" href="a00050.html#a7e2ee7629f23b4079ba1dd1e23f7dea">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00136.html">scim_imengine.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:40 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>
|
