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
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
|
<!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::HelperAgent 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="a00042.html">HelperAgent</a></div>
<h1>scim::HelperAgent Class Reference<br>
<small>
[<a class="el" href="a00163.html">Helper</a>]</small>
</h1><!-- doxytag: class="scim::HelperAgent" -->The accessory class to write a Helper object.
<a href="#_details">More...</a>
<p>
<code>#include <scim_helper.h></code>
<p>
<a href="a00360.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="a00042.html#1b20738bf66e47fa8b9ecdf083f26caf">HelperAgent</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#005c687db22fd3d42c530606178c7515">~HelperAgent</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#a45676e865f37d2338738a8599ceb457">open_connection</a> (const <a class="el" href="a00044.html">HelperInfo</a> &info, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &display)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open socket connection to the Panel. <a href="#a45676e865f37d2338738a8599ceb457"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#2bc2fc938c2bd4e3a7a9a5aa3ea45dc2">close_connection</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the socket connection to Panel. <a href="#2bc2fc938c2bd4e3a7a9a5aa3ea45dc2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#924edbd1cbe55ae3fef4a278d5684b77">get_connection_number</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the connection id previously returned by <a class="el" href="a00042.html#a45676e865f37d2338738a8599ceb457">open_connection()</a>. <a href="#924edbd1cbe55ae3fef4a278d5684b77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#33262552050e6e6a1a944b91b0142b45">is_connected</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this <a class="el" href="a00042.html">HelperAgent</a> has been connected to a Panel. <a href="#33262552050e6e6a1a944b91b0142b45"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#ea0fd433eb8aa02e559fbb5195444e46">has_pending_event</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if there are any events available to be processed. <a href="#ea0fd433eb8aa02e559fbb5195444e46"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#9a57130bd77b87518834507005d87df1">filter_event</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Process the pending events. <a href="#9a57130bd77b87518834507005d87df1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#a33c81bf25c72b3888d8e6f8930930a7">reload_config</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request SCIM to reload all configuration. <a href="#a33c81bf25c72b3888d8e6f8930930a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#14bf317e06ef19a1187ad8f1de6f7d42">register_properties</a> (const <a class="el" href="a00158.html#gc4099a109cec998bbfad588fcf4c8f79">PropertyList</a> &properties) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register some properties into Panel. <a href="#14bf317e06ef19a1187ad8f1de6f7d42"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#25291200c97dcb424289979ad4483131">update_property</a> (const <a class="el" href="a00071.html">Property</a> &property) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update a registered property. <a href="#25291200c97dcb424289979ad4483131"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#c6f954257f134e2758d9d70dc669e972">send_imengine_event</a> (int ic, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &ic_uuid, const <a class="el" href="a00109.html">Transaction</a> &trans) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a set of events to an IMEngineInstance. <a href="#c6f954257f134e2758d9d70dc669e972"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#6c7e748c83532e7975da69f788932498">send_key_event</a> (int ic, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &ic_uuid, const <a class="el" href="a00054.html">KeyEvent</a> &key) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a <a class="el" href="a00054.html">KeyEvent</a> to an IMEngineInstance. <a href="#6c7e748c83532e7975da69f788932498"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#3f1b91c0830ac5f9722905bc3dd97b9d">forward_key_event</a> (int ic, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &ic_uuid, const <a class="el" href="a00054.html">KeyEvent</a> &key) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forward a <a class="el" href="a00054.html">KeyEvent</a> to client application directly. <a href="#3f1b91c0830ac5f9722905bc3dd97b9d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#75f2803123a4aed3f033e88a476c9802">commit_string</a> (int ic, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &ic_uuid, const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &wstr) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Commit a WideString to client application directly. <a href="#75f2803123a4aed3f033e88a476c9802"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#d4729b7edcb5dd7f1736ea36c3807b7b">signal_connect_exit</a> (<a class="el" href="a00099.html">HelperAgentSlotVoid</a> *slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a slot to Helper exit signal. <a href="#d4729b7edcb5dd7f1736ea36c3807b7b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#0d3474521c2a7a10f8adbaf52b06f96a">signal_connect_attach_input_context</a> (<a class="el" href="a00099.html">HelperAgentSlotVoid</a> *slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a slot to Helper attach input context signal. <a href="#0d3474521c2a7a10f8adbaf52b06f96a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#30a15fe30a1c8d8a7fe627f631c4cbc9">signal_connect_detach_input_context</a> (<a class="el" href="a00099.html">HelperAgentSlotVoid</a> *slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a slot to Helper detach input context signal. <a href="#30a15fe30a1c8d8a7fe627f631c4cbc9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#24c81302c47ff004ad725cb431eb5a8f">signal_connect_reload_config</a> (<a class="el" href="a00099.html">HelperAgentSlotVoid</a> *slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a slot to Helper reload config signal. <a href="#24c81302c47ff004ad725cb431eb5a8f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#e8b50c20f0ed142907fc3c9ca24c297f">signal_connect_update_screen</a> (<a class="el" href="a00100.html">HelperAgentSlotInt</a> *slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a slot to Helper update screen signal. <a href="#e8b50c20f0ed142907fc3c9ca24c297f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#106c8d4af72dd36c11d23e50bba6f16a">signal_connect_update_spot_location</a> (<a class="el" href="a00101.html">HelperAgentSlotIntInt</a> *slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a slot to Helper update spot location signal. <a href="#106c8d4af72dd36c11d23e50bba6f16a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#bbbb50a113d7b0cfbd2d837857720d23">signal_connect_trigger_property</a> (<a class="el" href="a00100.html">HelperAgentSlotString</a> *slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a slot to Helper trigger property signal. <a href="#bbbb50a113d7b0cfbd2d837857720d23"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00042.html#9821c4aeb68b7f4967ca0f533c7be819">signal_connect_process_imengine_event</a> (<a class="el" href="a00100.html">HelperAgentSlotTransaction</a> *slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a slot to Helper process imengine event signal. <a href="#9821c4aeb68b7f4967ca0f533c7be819"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The accessory class to write a Helper object.
<p>
This class implements all <a class="el" href="a00104.html">Socket</a> <a class="el" href="a00109.html">Transaction</a> protocol between Helper object and Panel.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1b20738bf66e47fa8b9ecdf083f26caf"></a><!-- doxytag: member="scim::HelperAgent::HelperAgent" ref="1b20738bf66e47fa8b9ecdf083f26caf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::HelperAgent::HelperAgent </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="005c687db22fd3d42c530606178c7515"></a><!-- doxytag: member="scim::HelperAgent::~HelperAgent" ref="005c687db22fd3d42c530606178c7515" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::HelperAgent::~HelperAgent </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="a45676e865f37d2338738a8599ceb457"></a><!-- doxytag: member="scim::HelperAgent::open_connection" ref="a45676e865f37d2338738a8599ceb457" args="(const HelperInfo &info, const String &display)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int scim::HelperAgent::open_connection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00044.html">HelperInfo</a> & </td>
<td class="paramname"> <em>info</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>display</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>
Open socket connection to the Panel.
<p>
Helper objects and Panel communicate with each other via the <a class="el" href="a00104.html">Socket</a> created by Panel, just same as the <a class="el" href="a00104.html">Socket</a> between FrontEnds and Panel.<p>
Helper object can select/poll on the connection id returned by this function to see if there are any data available to be read. If any data are available, Helper object should call <a class="el" href="a00042.html#9a57130bd77b87518834507005d87df1">HelperAgent::filter_event()</a> to process the data.<p>
This method should be called after the necessary signal-slots are connected. If this Helper is started by an IMEngine Instance, then signal attach_input_context will be emitted during this call.<p>
<a class="el" href="a00073.html">Signal</a> update_screen will be emitted during this call as well to set the startup screen of this Helper. The ic and ic_uuid parameters are invalid here.<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>info</em> </td><td>The information of this Helper object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>display</em> </td><td>The display which this Helper object should run on.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The connection socket id. -1 means failed to create the connection. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2bc2fc938c2bd4e3a7a9a5aa3ea45dc2"></a><!-- doxytag: member="scim::HelperAgent::close_connection" ref="2bc2fc938c2bd4e3a7a9a5aa3ea45dc2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperAgent::close_connection </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close the socket connection to Panel.
<p>
</div>
</div><p>
<a class="anchor" name="924edbd1cbe55ae3fef4a278d5684b77"></a><!-- doxytag: member="scim::HelperAgent::get_connection_number" ref="924edbd1cbe55ae3fef4a278d5684b77" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int scim::HelperAgent::get_connection_number </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the connection id previously returned by <a class="el" href="a00042.html#a45676e865f37d2338738a8599ceb457">open_connection()</a>.
<p>
</div>
</div><p>
<a class="anchor" name="33262552050e6e6a1a944b91b0142b45"></a><!-- doxytag: member="scim::HelperAgent::is_connected" ref="33262552050e6e6a1a944b91b0142b45" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::HelperAgent::is_connected </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return whether this <a class="el" href="a00042.html">HelperAgent</a> has been connected to a Panel.
<p>
</div>
</div><p>
<a class="anchor" name="ea0fd433eb8aa02e559fbb5195444e46"></a><!-- doxytag: member="scim::HelperAgent::has_pending_event" ref="ea0fd433eb8aa02e559fbb5195444e46" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::HelperAgent::has_pending_event </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if there are any events available to be processed.
<p>
If it returns true then Helper object should call <a class="el" href="a00042.html#9a57130bd77b87518834507005d87df1">HelperAgent::filter_event()</a> to process them.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if there are any events available. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9a57130bd77b87518834507005d87df1"></a><!-- doxytag: member="scim::HelperAgent::filter_event" ref="9a57130bd77b87518834507005d87df1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::HelperAgent::filter_event </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process the pending events.
<p>
This function will emit the corresponding signals according to the events.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>false if the connection is broken, otherwise return true. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a33c81bf25c72b3888d8e6f8930930a7"></a><!-- doxytag: member="scim::HelperAgent::reload_config" ref="a33c81bf25c72b3888d8e6f8930930a7" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperAgent::reload_config </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Request SCIM to reload all configuration.
<p>
This function should only by used by Setup Helper to request scim's reloading the configuration.
</div>
</div><p>
<a class="anchor" name="14bf317e06ef19a1187ad8f1de6f7d42"></a><!-- doxytag: member="scim::HelperAgent::register_properties" ref="14bf317e06ef19a1187ad8f1de6f7d42" args="(const PropertyList &properties) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperAgent::register_properties </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00158.html#gc4099a109cec998bbfad588fcf4c8f79">PropertyList</a> & </td>
<td class="paramname"> <em>properties</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register some properties into Panel.
<p>
This function send the request to Panel to register a list of Properties.<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>properties</em> </td><td>The list of Properties to be registered into Panel.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00071.html">scim::Property</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="25291200c97dcb424289979ad4483131"></a><!-- doxytag: member="scim::HelperAgent::update_property" ref="25291200c97dcb424289979ad4483131" args="(const Property &property) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperAgent::update_property </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00071.html">Property</a> & </td>
<td class="paramname"> <em>property</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update a registered property.
<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 property to be updated. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c6f954257f134e2758d9d70dc669e972"></a><!-- doxytag: member="scim::HelperAgent::send_imengine_event" ref="c6f954257f134e2758d9d70dc669e972" args="(int ic, const String &ic_uuid, const Transaction &trans) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperAgent::send_imengine_event </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ic</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>ic_uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00109.html">Transaction</a> & </td>
<td class="paramname"> <em>trans</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>
Send a set of events to an IMEngineInstance.
<p>
All events should be put into a <a class="el" href="a00109.html">Transaction</a>. And the events can only be received by one IMEngineInstance 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>ic</em> </td><td>The handle of the Input Context to receive the events. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ic_uuid</em> </td><td>The UUID of the Input Context. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>The <a class="el" href="a00109.html">Transaction</a> object holds the events. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6c7e748c83532e7975da69f788932498"></a><!-- doxytag: member="scim::HelperAgent::send_key_event" ref="6c7e748c83532e7975da69f788932498" args="(int ic, const String &ic_uuid, const KeyEvent &key) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperAgent::send_key_event </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ic</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>ic_uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send a <a class="el" href="a00054.html">KeyEvent</a> to an IMEngineInstance.
<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>ic</em> </td><td>The handle of the IMEngineInstance to receive the event. -1 means the currently focused IMEngineInstance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ic_uuid</em> </td><td>The UUID of the IMEngineInstance. Empty means don't match. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The <a class="el" href="a00054.html">KeyEvent</a> to be sent. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3f1b91c0830ac5f9722905bc3dd97b9d"></a><!-- doxytag: member="scim::HelperAgent::forward_key_event" ref="3f1b91c0830ac5f9722905bc3dd97b9d" args="(int ic, const String &ic_uuid, const KeyEvent &key) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperAgent::forward_key_event </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ic</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>ic_uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Forward a <a class="el" href="a00054.html">KeyEvent</a> to client application directly.
<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>ic</em> </td><td>The handle of the client Input Context to receive the event. -1 means the currently focused Input Context. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ic_uuid</em> </td><td>The UUID of the IMEngine used by the Input Context. Empty means don't match. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The <a class="el" href="a00054.html">KeyEvent</a> to be forwarded. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="75f2803123a4aed3f033e88a476c9802"></a><!-- doxytag: member="scim::HelperAgent::commit_string" ref="75f2803123a4aed3f033e88a476c9802" args="(int ic, const String &ic_uuid, const WideString &wstr) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperAgent::commit_string </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ic</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>ic_uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> & </td>
<td class="paramname"> <em>wstr</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>
Commit a WideString to client application directly.
<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>ic</em> </td><td>The handle of the client Input Context to receive the WideString. -1 means the currently focused Input Context. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ic_uuid</em> </td><td>The UUID of the IMEngine used by the Input Context. Empty means don't match. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>wstr</em> </td><td>The WideString to be committed. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d4729b7edcb5dd7f1736ea36c3807b7b"></a><!-- doxytag: member="scim::HelperAgent::signal_connect_exit" ref="d4729b7edcb5dd7f1736ea36c3807b7b" args="(HelperAgentSlotVoid *slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00017.html">Connection</a> scim::HelperAgent::signal_connect_exit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00099.html">HelperAgentSlotVoid</a> * </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect a slot to Helper exit signal.
<p>
This signal is used to let the Helper exit.<p>
The prototype of the slot is:<p>
void exit (const <a class="el" href="a00042.html">HelperAgent</a> *agent, int ic, const String &ic_uuid);<p>
Parameters:<ul>
<li>agent The pointer to the <a class="el" href="a00042.html">HelperAgent</a> object which emits this signal.</li><li>ic An opaque handle of the currently focused input context.</li><li>ic_uuid The UUID of the IMEngineInstance associated with the focused input context. </li></ul>
</div>
</div><p>
<a class="anchor" name="0d3474521c2a7a10f8adbaf52b06f96a"></a><!-- doxytag: member="scim::HelperAgent::signal_connect_attach_input_context" ref="0d3474521c2a7a10f8adbaf52b06f96a" args="(HelperAgentSlotVoid *slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00017.html">Connection</a> scim::HelperAgent::signal_connect_attach_input_context </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00099.html">HelperAgentSlotVoid</a> * </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect a slot to Helper attach input context signal.
<p>
This signal is used to attach an input context to this helper.<p>
When an input context requst to start this helper, then this signal will be emitted as soon as the helper is started.<p>
When an input context want to start an already started helper, this signal will also be emitted.<p>
Helper can send some events back to the IMEngineInstance in this signal-slot, to inform that it has been started sccessfully.<p>
The prototype of the slot is:<p>
void attach_input_context (const <a class="el" href="a00042.html">HelperAgent</a> *agent, int ic, const String &ic_uuid);
</div>
</div><p>
<a class="anchor" name="30a15fe30a1c8d8a7fe627f631c4cbc9"></a><!-- doxytag: member="scim::HelperAgent::signal_connect_detach_input_context" ref="30a15fe30a1c8d8a7fe627f631c4cbc9" args="(HelperAgentSlotVoid *slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00017.html">Connection</a> scim::HelperAgent::signal_connect_detach_input_context </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00099.html">HelperAgentSlotVoid</a> * </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect a slot to Helper detach input context signal.
<p>
This signal is used to detach an input context from this helper.<p>
When an input context requst to stop this helper, then this signal will be emitted.<p>
Helper shouldn't send any event back to the IMEngineInstance, because the IMEngineInstance attached to the ic should have been destroyed.<p>
The prototype of the slot is:<p>
void detach_input_context (const <a class="el" href="a00042.html">HelperAgent</a> *agent, int ic, const String &ic_uuid);
</div>
</div><p>
<a class="anchor" name="24c81302c47ff004ad725cb431eb5a8f"></a><!-- doxytag: member="scim::HelperAgent::signal_connect_reload_config" ref="24c81302c47ff004ad725cb431eb5a8f" args="(HelperAgentSlotVoid *slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00017.html">Connection</a> scim::HelperAgent::signal_connect_reload_config </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00099.html">HelperAgentSlotVoid</a> * </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect a slot to Helper reload config signal.
<p>
This signal is used to let the Helper reload configuration.<p>
The prototype of the slot is:<p>
void reload_config (const <a class="el" href="a00042.html">HelperAgent</a> *agent, int ic, const String &ic_uuid);
</div>
</div><p>
<a class="anchor" name="e8b50c20f0ed142907fc3c9ca24c297f"></a><!-- doxytag: member="scim::HelperAgent::signal_connect_update_screen" ref="e8b50c20f0ed142907fc3c9ca24c297f" args="(HelperAgentSlotInt *slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00017.html">Connection</a> scim::HelperAgent::signal_connect_update_screen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00100.html">HelperAgentSlotInt</a> * </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect a slot to Helper update screen signal.
<p>
This signal is used to let the Helper move its GUI to another screen. It can only be emitted when SCIM_HELPER_NEED_SCREEN_INFO is set in <a class="el" href="a00044.html#e1ecaa5236128066caae5e070241d6a4">HelperInfo.option</a>.<p>
The prototype of the slot is:<p>
void update_screen (const <a class="el" href="a00042.html">HelperAgent</a> *agent, int ic, const String &ic_uuid, int screen_number);
</div>
</div><p>
<a class="anchor" name="106c8d4af72dd36c11d23e50bba6f16a"></a><!-- doxytag: member="scim::HelperAgent::signal_connect_update_spot_location" ref="106c8d4af72dd36c11d23e50bba6f16a" args="(HelperAgentSlotIntInt *slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00017.html">Connection</a> scim::HelperAgent::signal_connect_update_spot_location </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00101.html">HelperAgentSlotIntInt</a> * </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect a slot to Helper update spot location signal.
<p>
This signal is used to let the Helper move its GUI according to the current spot location. It can only be emitted when SCIM_HELPER_NEED_SPOT_LOCATION_INFO is set in <a class="el" href="a00044.html#e1ecaa5236128066caae5e070241d6a4">HelperInfo.option</a>.<p>
The prototype of the slot is: void update_spot_location (const <a class="el" href="a00042.html">HelperAgent</a> *agent, int ic, const String &ic_uuid, int x, int y);
</div>
</div><p>
<a class="anchor" name="bbbb50a113d7b0cfbd2d837857720d23"></a><!-- doxytag: member="scim::HelperAgent::signal_connect_trigger_property" ref="bbbb50a113d7b0cfbd2d837857720d23" args="(HelperAgentSlotString *slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00017.html">Connection</a> scim::HelperAgent::signal_connect_trigger_property </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00100.html">HelperAgentSlotString</a> * </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect a slot to Helper trigger property signal.
<p>
This signal is used to trigger a property registered by this Helper. A property will be triggered when user clicks on it.<p>
The prototype of the slot is: void trigger_property (const <a class="el" href="a00042.html">HelperAgent</a> *agent, int ic, const String &ic_uuid, const String &property);
</div>
</div><p>
<a class="anchor" name="9821c4aeb68b7f4967ca0f533c7be819"></a><!-- doxytag: member="scim::HelperAgent::signal_connect_process_imengine_event" ref="9821c4aeb68b7f4967ca0f533c7be819" args="(HelperAgentSlotTransaction *slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00017.html">Connection</a> scim::HelperAgent::signal_connect_process_imengine_event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00100.html">HelperAgentSlotTransaction</a> * </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect a slot to Helper process imengine event signal.
<p>
This signal is used to deliver the events sent from IMEngine to Helper.<p>
The prototype of the slot is: void process_imengine_event (const <a class="el" href="a00042.html">HelperAgent</a> *agent, int ic, const String &ic_uuid, const <a class="el" href="a00109.html">Transaction</a> &transaction);
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00131.html">scim_helper.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>
|
