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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
|
<!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::FilterFactoryBase 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="a00026.html">FilterFactoryBase</a></div>
<h1>scim::FilterFactoryBase Class Reference<br>
<small>
[<a class="el" href="a00160.html">IMEngine</a>]</small>
</h1><!-- doxytag: class="scim::FilterFactoryBase" --><!-- doxytag: inherits="scim::IMEngineFactoryBase" -->The base class to implement FilterFactory classes.
<a href="#_details">More...</a>
<p>
<code>#include <scim_filter.h></code>
<p>
Inheritance diagram for scim::FilterFactoryBase:<p><center><img src="a00327.png" border="0" usemap="#a00328" alt="Inheritance graph"></center>
<map name="a00328">
<area href="a00050.html" shape="rect" coords="7,83,196,107" alt="">
<area href="a00072.html" shape="rect" coords="16,8,187,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for scim::FilterFactoryBase:<p><center><img src="a00329.png" border="0" usemap="#a00330" alt="Collaboration graph"></center>
<map name="a00330">
<area href="a00050.html" shape="rect" coords="7,99,196,123" alt="">
<area href="a00072.html" shape="rect" coords="16,8,187,32" alt="">
<area href="a00070.html" shape="rect" coords="220,99,361,123" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="a00331.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="a00026.html#012dd475468844e38bf701ce6a244dbe">FilterFactoryBase</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#012dd475468844e38bf701ce6a244dbe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#d043c68ca6985d8362fbea621c7e0068">~FilterFactoryBase</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory</a> (const <a class="el" href="a00070.html">IMEngineFactoryPointer</a> &orig)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach an IMEngineFactory object to this filter. <a href="#596f3b5027bdc9e808a954f6390ce5f0"></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="a00026.html#9eaad8caabdd2ed6e4cae1c176f2fed0">get_name</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#9eaad8caabdd2ed6e4cae1c176f2fed0"></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="a00026.html#ef8a00920a42d0cdccb976c942675a4e">get_uuid</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the uuid of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#ef8a00920a42d0cdccb976c942675a4e"></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="a00026.html#9eafcbda3c01c1a67a015ea6e952488e">get_icon_file</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the icon file path of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#9eafcbda3c01c1a67a015ea6e952488e"></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="a00026.html#e516dde330d2baa99c747c0a6895ef8d">get_authors</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the authors information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#e516dde330d2baa99c747c0a6895ef8d"></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="a00026.html#d1129c06b1cda357209f86df2fb0b932">get_credits</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the credits information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#d1129c06b1cda357209f86df2fb0b932"></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="a00026.html#b3d60924346b8de07341803de626c247">get_help</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the help information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#b3d60924346b8de07341803de626c247"></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="a00026.html#23b6c2e2dec13497fc2f9f849e9efc16">get_language</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the supported language of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#23b6c2e2dec13497fc2f9f849e9efc16"></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="a00026.html#866e4eb43785fce0e5a516c0dddbd3a2">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 the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#866e4eb43785fce0e5a516c0dddbd3a2"></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="a00026.html#48d668ce1300b27ce30eb582127c3730">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 an locale is supported by the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#48d668ce1300b27ce30eb582127c3730"></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="a00026.html#f0556243a1a02638f6b57c1fb5c81716">inverse_query</a> (const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the original key string of a composed string by calling the same method of the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#f0556243a1a02638f6b57c1fb5c81716"></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="a00026.html#cbd863c653e886faa3891be6cb722052">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 an IMEngineInstance object of the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method. <a href="#cbd863c653e886faa3891be6cb722052"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The base class to implement FilterFactory classes.
<p>
All FilterFactory classes should derive from this class and some base methods should be overrided in the derived classes.<p>
If a FilterFactory object need large amount of data (eg. mapping table etc.), it'd better to share these data among all other objects of the same class. Because multiple objects of one FilterFactory class maybe used at the same time to filter several real IMEngineFactory objects.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="012dd475468844e38bf701ce6a244dbe"></a><!-- doxytag: member="scim::FilterFactoryBase::FilterFactoryBase" ref="012dd475468844e38bf701ce6a244dbe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::FilterFactoryBase::FilterFactoryBase </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default Constructor.
<p>
</div>
</div><p>
<a class="anchor" name="d043c68ca6985d8362fbea621c7e0068"></a><!-- doxytag: member="scim::FilterFactoryBase::~FilterFactoryBase" ref="d043c68ca6985d8362fbea621c7e0068" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual scim::FilterFactoryBase::~FilterFactoryBase </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="596f3b5027bdc9e808a954f6390ce5f0"></a><!-- doxytag: member="scim::FilterFactoryBase::attach_imengine_factory" ref="596f3b5027bdc9e808a954f6390ce5f0" args="(const IMEngineFactoryPointer &orig)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterFactoryBase::attach_imengine_factory </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00070.html">IMEngineFactoryPointer</a> & </td>
<td class="paramname"> <em>orig</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attach an IMEngineFactory object to this filter.
<p>
The attached object could also be a filter.<p>
This method will set the supported locales of this filter factory to the locales supported by the original IMEngineFactory object.<p>
This method could be overrided in derived class, in which some special tasks could be done, for example, set additional supported locales. But this method of base class must be invoked to attach the factory correctly.<p>
The IMEngineFactoryPointer orig may not be kept and used by derived class directly. All tasks related to the original IMEngineFactory object should be done by calling the corresponding methods of <a class="el" href="a00026.html">FilterFactoryBase</a> class.<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>orig</em> </td><td>The original IMEngineFactory object to be filtered. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9eaad8caabdd2ed6e4cae1c176f2fed0"></a><!-- doxytag: member="scim::FilterFactoryBase::get_name" ref="9eaad8caabdd2ed6e4cae1c176f2fed0" 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::FilterFactoryBase::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>
Return the name of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the name of the filter itself when it returns an empty string.<p>
The derived method should look like:<p>
<pre>
WideString
XXXFilterFactory::get_name ()
{
WideString name = <a class="el" href="a00026.html#9eaad8caabdd2ed6e4cae1c176f2fed0">FilterFactoryBase::get_name</a> ();
return name.length () ? name : _("XXX");
}
</pre>
<p>
Implements <a class="el" href="a00050.html#20d91317ff7c2cc60725210049e705ea">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="ef8a00920a42d0cdccb976c942675a4e"></a><!-- doxytag: member="scim::FilterFactoryBase::get_uuid" ref="ef8a00920a42d0cdccb976c942675a4e" 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::FilterFactoryBase::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>
Return the uuid of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the uuid of the filter itself when it returns an empty string.
<p>
Implements <a class="el" href="a00050.html#189ce916ba791abcf6c2553d8ebc11e0">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="9eafcbda3c01c1a67a015ea6e952488e"></a><!-- doxytag: member="scim::FilterFactoryBase::get_icon_file" ref="9eafcbda3c01c1a67a015ea6e952488e" 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::FilterFactoryBase::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>
Return the icon file path of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the icon file path of the filter itself when it returns an empty string.
<p>
Implements <a class="el" href="a00050.html#f22c5cce4801400553d0686d58da3e9e">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="e516dde330d2baa99c747c0a6895ef8d"></a><!-- doxytag: member="scim::FilterFactoryBase::get_authors" ref="e516dde330d2baa99c747c0a6895ef8d" 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::FilterFactoryBase::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>
Return the authors information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the authors information of the filter itself when it returns an empty string.
<p>
Implements <a class="el" href="a00050.html#4874af640b799b0feb602d43fb016d22">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="d1129c06b1cda357209f86df2fb0b932"></a><!-- doxytag: member="scim::FilterFactoryBase::get_credits" ref="d1129c06b1cda357209f86df2fb0b932" 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::FilterFactoryBase::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>
Return the credits information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the credits information of the filter itself when it returns an empty string.
<p>
Implements <a class="el" href="a00050.html#80b752a4058c0a7866f0d772bd9193d6">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="b3d60924346b8de07341803de626c247"></a><!-- doxytag: member="scim::FilterFactoryBase::get_help" ref="b3d60924346b8de07341803de626c247" 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::FilterFactoryBase::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>
Return the help information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the combined help information of the filter itself and the original IMEngineFactory to be filtered.
<p>
Implements <a class="el" href="a00050.html#aa4f1d3099956c7d7795df62aa0811f2">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="23b6c2e2dec13497fc2f9f849e9efc16"></a><!-- doxytag: member="scim::FilterFactoryBase::get_language" ref="23b6c2e2dec13497fc2f9f849e9efc16" 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::FilterFactoryBase::get_language </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the supported language of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class may override this method to return a different language which is supported by the filter itself.
<p>
Reimplemented from <a class="el" href="a00050.html#b31e429533cd515fad47c045cc5bb711">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="866e4eb43785fce0e5a516c0dddbd3a2"></a><!-- doxytag: member="scim::FilterFactoryBase::validate_encoding" ref="866e4eb43785fce0e5a516c0dddbd3a2" args="(const String &encoding) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::FilterFactoryBase::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 the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
If there is no IMEngineFactory attached yet, then false would be returned.<p>
The derived class may override this method to provide its own validate routing.
<p>
Reimplemented from <a class="el" href="a00050.html#8149111b68c2b10a515a307b7476ae6c">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="48d668ce1300b27ce30eb582127c3730"></a><!-- doxytag: member="scim::FilterFactoryBase::validate_locale" ref="48d668ce1300b27ce30eb582127c3730" args="(const String &locale) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::FilterFactoryBase::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 an locale is supported by the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
If there is no IMEngineFactory attached yet, then false would be returned.<p>
The derived class may override this method to provide its own validate routing.
<p>
Reimplemented from <a class="el" href="a00050.html#f9ca6ba3bcff44112df84cd98b02c88f">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="f0556243a1a02638f6b57c1fb5c81716"></a><!-- doxytag: member="scim::FilterFactoryBase::inverse_query" ref="f0556243a1a02638f6b57c1fb5c81716" args="(const WideString &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FilterFactoryBase::inverse_query </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> & </td>
<td class="paramname"> <em>str</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the original key string of a composed string by calling the same method of the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.
<p>
Reimplemented from <a class="el" href="a00050.html#8e0f6c3450532bb3b4fa84de3a97c8fe">scim::IMEngineFactoryBase</a>.
</div>
</div><p>
<a class="anchor" name="cbd863c653e886faa3891be6cb722052"></a><!-- doxytag: member="scim::FilterFactoryBase::create_instance" ref="cbd863c653e886faa3891be6cb722052" 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::FilterFactoryBase::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 an IMEngineInstance object of the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory()</a> method.
<p>
The derived class should override this method and create its own instance object from the result of this base method.<p>
The code may look like:<p>
<pre>
IMEngineInstancePointer
XXXFilterFactory::create_instance (const String& encoding, int id)
{
return new XXXFilterInstance (this, <a class="el" href="a00026.html#cbd863c653e886faa3891be6cb722052">FilterFactoryBase::create_instance</a> (encoding, id));
}
</pre>
<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="a00125.html">scim_filter.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:38 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>
|
