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
|
<!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::FilterManager 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="a00029.html">FilterManager</a></div>
<h1>scim::FilterManager Class Reference<br>
<small>
[<a class="el" href="a00160.html">IMEngine</a>]</small>
</h1><!-- doxytag: class="scim::FilterManager" --><code>#include <scim_filter_manager.h></code>
<p>
<a href="a00337.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="a00029.html#86518cdc562b40d8f577451196382f9a">FilterManager</a> (const <a class="el" href="a00070.html">ConfigPointer</a> &config)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#0078c1e4002e6769f977e79a91bf6120">~FilterManager</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ce9bc1204e860c1612c9a58979769f4e">number_of_filters</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the total number of Filters supported by all filter modules. <a href="#ce9bc1204e860c1612c9a58979769f4e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#086bde3fbcff18d228b6198102f77321">get_filter_info</a> (unsigned int idx, <a class="el" href="a00027.html">FilterInfo</a> &info) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the information of a specific filter by its index. <a href="#086bde3fbcff18d228b6198102f77321"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#3bb162356f9f3a3187a37618ef80f597">get_filter_info</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid, <a class="el" href="a00027.html">FilterInfo</a> &info) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the information of a specific filter by its uuid. <a href="#3bb162356f9f3a3187a37618ef80f597"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#68e2f0d02aa6419e67f8e4b8c6191a6a">clear_all_filter_settings</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all Filter settings for IMEngines. <a href="#68e2f0d02aa6419e67f8e4b8c6191a6a"></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="a00029.html#2dba5dee53ef5f0fff303143420a9afa">get_filters_for_imengine</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid, std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > &filters) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of Filters binded to an IMEngine. <a href="#2dba5dee53ef5f0fff303143420a9afa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#7aaf52c359c79e973a423d4c807fcb00">set_filters_for_imengine</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid, const std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > &filters) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bind one or more Filters to an IMEngine. <a href="#7aaf52c359c79e973a423d4c807fcb00"></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="a00029.html#2dc42eff8240a06d11d5e4ac9704c596">get_filtered_imengines</a> (std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > &imengines) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of imengines which have one or more filters attached. <a href="#2dc42eff8240a06d11d5e4ac9704c596"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00070.html">FilterFactoryPointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#877eabd9eaece6f0895dfa74ac122848">create_filter</a> (unsigned int idx) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a FilterFactory according to its index. <a href="#877eabd9eaece6f0895dfa74ac122848"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00070.html">FilterFactoryPointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#1e8178b88b4d6daaff0950471e31abc0">create_filter</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a FilterFactory according to its UUID. <a href="#1e8178b88b4d6daaff0950471e31abc0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00070.html">IMEngineFactoryPointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#d82fc197d2283932ecc13935f2e3fd39">attach_filters_to_factory</a> (const <a class="el" href="a00070.html">IMEngineFactoryPointer</a> &factory) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach all binded Filters to an IMEngineFactory object. <a href="#d82fc197d2283932ecc13935f2e3fd39"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="86518cdc562b40d8f577451196382f9a"></a><!-- doxytag: member="scim::FilterManager::FilterManager" ref="86518cdc562b40d8f577451196382f9a" args="(const ConfigPointer &config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::FilterManager::FilterManager </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>
</div>
</div><p>
<a class="anchor" name="0078c1e4002e6769f977e79a91bf6120"></a><!-- doxytag: member="scim::FilterManager::~FilterManager" ref="0078c1e4002e6769f977e79a91bf6120" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::FilterManager::~FilterManager </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="ce9bc1204e860c1612c9a58979769f4e"></a><!-- doxytag: member="scim::FilterManager::number_of_filters" ref="ce9bc1204e860c1612c9a58979769f4e" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int scim::FilterManager::number_of_filters </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the total number of Filters supported by all filter modules.
<p>
</div>
</div><p>
<a class="anchor" name="086bde3fbcff18d228b6198102f77321"></a><!-- doxytag: member="scim::FilterManager::get_filter_info" ref="086bde3fbcff18d228b6198102f77321" args="(unsigned int idx, FilterInfo &info) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FilterManager::get_filter_info </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00027.html">FilterInfo</a> & </td>
<td class="paramname"> <em>info</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 the information of a specific filter by its index.
<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>idx</em> </td><td>The index of the filter, must between 0 to number_of_filters () - 1. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>info</em> </td><td>The <a class="el" href="a00027.html">FilterInfo</a> object to store the information. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if this filter is ok and the information is stored correctly. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3bb162356f9f3a3187a37618ef80f597"></a><!-- doxytag: member="scim::FilterManager::get_filter_info" ref="3bb162356f9f3a3187a37618ef80f597" args="(const String &uuid, FilterInfo &info) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FilterManager::get_filter_info </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="a00027.html">FilterInfo</a> & </td>
<td class="paramname"> <em>info</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 the information of a specific filter by its 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 uuid of the filter. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>info</em> </td><td>The <a class="el" href="a00027.html">FilterInfo</a> object to store the information. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if this filter is ok and the information is stored correctly. </dd></dl>
</div>
</div><p>
<a class="anchor" name="68e2f0d02aa6419e67f8e4b8c6191a6a"></a><!-- doxytag: member="scim::FilterManager::clear_all_filter_settings" ref="68e2f0d02aa6419e67f8e4b8c6191a6a" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FilterManager::clear_all_filter_settings </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear all Filter settings for IMEngines.
<p>
</div>
</div><p>
<a class="anchor" name="2dba5dee53ef5f0fff303143420a9afa"></a><!-- doxytag: member="scim::FilterManager::get_filters_for_imengine" ref="2dba5dee53ef5f0fff303143420a9afa" args="(const String &uuid, std::vector< String > &filters) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t scim::FilterManager::get_filters_for_imengine </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">std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > & </td>
<td class="paramname"> <em>filters</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 a list of Filters binded to an IMEngine.
<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 uuid of the IMEngine to be queried. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>filters</em> </td><td>The list of Filters' UUIDs binded to the IMEngine will be stored here.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>How many filters binded to this IMEngine. </dd></dl>
</div>
</div><p>
<a class="anchor" name="7aaf52c359c79e973a423d4c807fcb00"></a><!-- doxytag: member="scim::FilterManager::set_filters_for_imengine" ref="7aaf52c359c79e973a423d4c807fcb00" args="(const String &uuid, const std::vector< String > &filters) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FilterManager::set_filters_for_imengine </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">const std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > & </td>
<td class="paramname"> <em>filters</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>
Bind one or more Filters to an IMEngine.
<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 uuid of the IMEngine to be binded. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>filters</em> </td><td>The list of Filters' UUIDs to be binded to the IMEngine. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2dc42eff8240a06d11d5e4ac9704c596"></a><!-- doxytag: member="scim::FilterManager::get_filtered_imengines" ref="2dc42eff8240a06d11d5e4ac9704c596" args="(std::vector< String > &imengines) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t scim::FilterManager::get_filtered_imengines </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > & </td>
<td class="paramname"> <em>imengines</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a list of imengines which have one or more filters attached.
<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>imengines</em> </td><td>The UUIDs of filtered imengines will be stored here. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>How many imengines are being filtered. </dd></dl>
</div>
</div><p>
<a class="anchor" name="877eabd9eaece6f0895dfa74ac122848"></a><!-- doxytag: member="scim::FilterManager::create_filter" ref="877eabd9eaece6f0895dfa74ac122848" args="(unsigned int idx) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00070.html">FilterFactoryPointer</a> scim::FilterManager::create_filter </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a FilterFactory according to its index.
<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>idx</em> </td><td>The index of the filter to be created, must be less than <a class="el" href="a00029.html#ce9bc1204e860c1612c9a58979769f4e">number_of_filters()</a> - 1. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The pointer of the FilterFactory object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="1e8178b88b4d6daaff0950471e31abc0"></a><!-- doxytag: member="scim::FilterManager::create_filter" ref="1e8178b88b4d6daaff0950471e31abc0" args="(const String &uuid) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00070.html">FilterFactoryPointer</a> scim::FilterManager::create_filter </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>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a FilterFactory according to its 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 UUID of the filter to be created. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The pointer of the FilterFactory object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d82fc197d2283932ecc13935f2e3fd39"></a><!-- doxytag: member="scim::FilterManager::attach_filters_to_factory" ref="d82fc197d2283932ecc13935f2e3fd39" args="(const IMEngineFactoryPointer &factory) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00070.html">IMEngineFactoryPointer</a> scim::FilterManager::attach_filters_to_factory </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00070.html">IMEngineFactoryPointer</a> & </td>
<td class="paramname"> <em>factory</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attach all binded Filters to an IMEngineFactory object.
<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>factory</em> </td><td>The pointer to an IMEngineFactory object which would be filtered.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>New pointer of IMEngineFactory object which has Filters binded. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00126.html">scim_filter_manager.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>
|
