← Back to branch summary

~ubuntu-branches/ubuntu/karmic/ibus/karmic-updates

« back to all changes in this revision

Viewing changes to docs/reference/ibus/xml/ibusengine.xml

  • Committer: Bazaar Package Importer
  • Author(s): LI Daobing
  • Date: 2009-06-13 11:39:05 UTC
  • mfrom: (1.1.3 upstream) (6.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20090613113905-0mfi5hhoz8w9y6k2
Tags: 1.1.0.20090612-1
http://bugs.debian.org/532163
* new upstream release.
* Fix "python-ibus should depends on iso-codes" (Closes: #532163)
* debian/libibus0.symbols: update symbols

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/ibus/xml/ibusengine.xml
83
83
<refsect1 id="IBusEngine.signals" role="signal_proto">
84
84
<title role="signal_proto.title">Signals</title>
85
85
<synopsis>
 
86
  &quot;<link linkend="IBusEngine-candidate-clicked">candidate-clicked</link>&quot;                              : Run Last
86
87
  &quot;<link linkend="IBusEngine-cursor-down">cursor-down</link>&quot;                                    : Run Last
87
88
  &quot;<link linkend="IBusEngine-cursor-up">cursor-up</link>&quot;                                      : Run Last
88
89
  &quot;<link linkend="IBusEngine-disable">disable</link>&quot;                                        : Run Last
419
420
 
420
421
<refsect1 id="IBusEngine.signal-details" role="signals">
421
422
<title role="signals.title">Signal Details</title>
422
 
<refsect2 id="IBusEngine-cursor-down" role="signal"><title>The <literal>&quot;cursor-down&quot;</literal> signal</title>
 
423
<refsect2 id="IBusEngine-candidate-clicked" role="signal"><title>The <literal>&quot;candidate-clicked&quot;</literal> signal</title>
 
424
<indexterm zone="IBusEngine-candidate-clicked"><primary sortas="IBusEngine::candidate-clicked">IBusEngine::candidate-clicked</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="IBusEngine">IBusEngine</link> *engine,
 
425
                                                        <link linkend="guint">guint</link>       arg1,
 
426
                                                        <link linkend="guint">guint</link>       arg2,
 
427
                                                        <link linkend="guint">guint</link>       arg3,
 
428
                                                        <link linkend="gpointer">gpointer</link>    user_data)      : Run Last</programlisting>
 
429
<para>
 
430
Emitted when candidate on lookup table is clicked.
 
431
Implement the member function <link linkend="candidate-clicked"><function>candidate_clicked()</function></link> in extended class to receive this signal.
 
432
</para>
 
433
<para>
 
434
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
 
435
<para>
 
436
</para><variablelist role="params">
 
437
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
 
438
<listitem><simpara> An IBusEngine.
 
439
</simpara></listitem></varlistentry>
 
440
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
441
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
442
</variablelist></refsect2><refsect2 id="IBusEngine-cursor-down" role="signal"><title>The <literal>&quot;cursor-down&quot;</literal> signal</title>
423
443
<indexterm zone="IBusEngine-cursor-down"><primary sortas="IBusEngine::cursor-down">IBusEngine::cursor-down</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="IBusEngine">IBusEngine</link> *engine,
424
444
                                                        <link linkend="gpointer">gpointer</link>    user_data)      : Run Last</programlisting>
425
445
<para>
426
 
Emitted when the down cursor key is pressed.
 
446
Emitted when the down cursor button is pressed.
427
447
Implement the member function <link linkend="cursor-down"><function>cursor_down()</function></link> in extended class to receive this signal.
428
448
</para>
429
449
<para>
430
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
450
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
431
451
<para>
432
452
</para><variablelist role="params">
433
453
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
439
459
<indexterm zone="IBusEngine-cursor-up"><primary sortas="IBusEngine::cursor-up">IBusEngine::cursor-up</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="IBusEngine">IBusEngine</link> *engine,
440
460
                                                        <link linkend="gpointer">gpointer</link>    user_data)      : Run Last</programlisting>
441
461
<para>
442
 
Emitted when the up cursor key is pressed.
 
462
Emitted when the up cursor button is pressed.
443
463
Implement the member function <link linkend="cursor-up"><function>cursor_up()</function></link> in extended class to receive this signal.
444
464
</para>
445
465
<para>
446
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
466
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
447
467
<para>
448
468
</para><variablelist role="params">
449
469
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
459
479
Implement the member function <link linkend="set-disable"><function>set_disable()</function></link> in extended class to receive this signal.
460
480
</para>
461
481
<para>
462
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
482
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
463
483
<para>
464
484
</para><variablelist role="params">
465
485
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
475
495
Implement the member function <link linkend="set-enable"><function>set_enable()</function></link> in extended class to receive this signal.
476
496
</para>
477
497
<para>
478
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
498
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
479
499
<para>
480
500
</para><variablelist role="params">
481
501
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
487
507
<indexterm zone="IBusEngine-focus-in"><primary sortas="IBusEngine::focus-in">IBusEngine::focus-in</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="IBusEngine">IBusEngine</link> *engine,
488
508
                                                        <link linkend="gpointer">gpointer</link>    user_data)      : Run Last</programlisting>
489
509
<para>
490
 
Emitted  when the client application get the focus.
 
510
Emitted when the client application get the focus.
491
511
Implement the member function <link linkend="focus-in"><function>focus_in()</function></link> in extended class to receive this signal.
492
512
</para>
493
513
<para>
494
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
514
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
495
515
<para>
496
516
</para><variablelist role="params">
497
517
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
507
527
Implement the member function <link linkend="focus-out"><function>focus_out()</function></link> in extended class to receive this signal.
508
528
</para>
509
529
<para>
510
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
530
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
511
531
<para>
512
532
</para><variablelist role="params">
513
533
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
519
539
<indexterm zone="IBusEngine-page-down"><primary sortas="IBusEngine::page-down">IBusEngine::page-down</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="IBusEngine">IBusEngine</link> *engine,
520
540
                                                        <link linkend="gpointer">gpointer</link>    user_data)      : Run Last</programlisting>
521
541
<para>
522
 
Emitted when the page-down key is pressed.
 
542
Emitted when the page-down button is pressed.
523
543
Implement the member function <link linkend="page-down"><function>page_down()</function></link> in extended class to receive this signal.
524
544
</para>
525
545
<para>
526
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
546
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
527
547
<para>
528
548
</para><variablelist role="params">
529
549
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
535
555
<indexterm zone="IBusEngine-page-up"><primary sortas="IBusEngine::page-up">IBusEngine::page-up</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="IBusEngine">IBusEngine</link> *engine,
536
556
                                                        <link linkend="gpointer">gpointer</link>    user_data)      : Run Last</programlisting>
537
557
<para>
538
 
Emitted when the page-up key is pressed.
 
558
Emitted when the page-up button is pressed.
539
559
Implement the member function <link linkend="page-up"><function>page_up()</function></link> in extended class to receive this signal.
540
560
</para>
541
561
<para>
542
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
562
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
543
563
<para>
544
564
</para><variablelist role="params">
545
565
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
557
577
Implement the member function <link linkend="process-key-event"><function>process_key_event()</function></link> in extended class to receive this signal.
558
578
</para>
559
579
<para>
560
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
580
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
561
581
<para>
562
582
</para><variablelist role="params">
563
583
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
581
601
Implement the member function <link linkend="property-activate"><function>property_activate()</function></link> in extended class to receive this signal.
582
602
</para>
583
603
<para>
584
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
604
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
585
605
<para>
586
606
</para><variablelist role="params">
587
607
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
598
618
Implement the member function <link linkend="property-hide"><function>property_hide()</function></link> in extended class to receive this signal.
599
619
</para>
600
620
<para>
601
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
621
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
602
622
<para>
603
623
</para><variablelist role="params">
604
624
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
615
635
Implement the member function <link linkend="property-side"><function>property_side()</function></link> in extended class to receive this signal.
616
636
</para>
617
637
<para>
618
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
638
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
619
639
<para>
620
640
</para><variablelist role="params">
621
641
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
631
651
Implement the member function <link linkend="reset"><function>reset()</function></link> in extended class to receive this signal.
632
652
</para>
633
653
<para>
634
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
654
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
635
655
<para>
636
656
</para><variablelist role="params">
637
657
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
648
668
Implement the member function <link linkend="set-capabilities"><function>set_capabilities()</function></link> in extended class to receive this signal.
649
669
</para>
650
670
<para>
651
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
671
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
652
672
<para>
653
673
</para><variablelist role="params">
654
674
<varlistentry><term><parameter>engine</parameter>&#160;:</term>
671
691
Implement the member function <link linkend="set-cursor-location"><function>set_cursor_location()</function></link> in extended class to receive this signal.
672
692
</para>
673
693
<para>
674
 
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
 
694
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
675
695
<para>
676
696
</para><variablelist role="params">
677
697
<varlistentry><term><parameter>engine</parameter>&#160;:</term>