83
83
<refsect1 id="IBusEngine.signals" role="signal_proto">
84
84
<title role="signal_proto.title">Signals</title>
86
"<link linkend="IBusEngine-candidate-clicked">candidate-clicked</link>" : Run Last
86
87
"<link linkend="IBusEngine-cursor-down">cursor-down</link>" : Run Last
87
88
"<link linkend="IBusEngine-cursor-up">cursor-up</link>" : Run Last
88
89
"<link linkend="IBusEngine-disable">disable</link>" : Run Last
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>"cursor-down"</literal> signal</title>
423
<refsect2 id="IBusEngine-candidate-clicked" role="signal"><title>The <literal>"candidate-clicked"</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>
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.
434
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
436
</para><variablelist role="params">
437
<varlistentry><term><parameter>engine</parameter> :</term>
438
<listitem><simpara> An IBusEngine.
439
</simpara></listitem></varlistentry>
440
<varlistentry><term><parameter>user_data</parameter> :</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>"cursor-down"</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>
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.
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>
432
452
</para><variablelist role="params">
433
453
<varlistentry><term><parameter>engine</parameter> :</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>
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.
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>
448
468
</para><variablelist role="params">
449
469
<varlistentry><term><parameter>engine</parameter> :</term>
459
479
Implement the member function <link linkend="set-disable"><function>set_disable()</function></link> in extended class to receive this signal.
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>
464
484
</para><variablelist role="params">
465
485
<varlistentry><term><parameter>engine</parameter> :</term>
475
495
Implement the member function <link linkend="set-enable"><function>set_enable()</function></link> in extended class to receive this signal.
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>
480
500
</para><variablelist role="params">
481
501
<varlistentry><term><parameter>engine</parameter> :</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>
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.
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>
496
516
</para><variablelist role="params">
497
517
<varlistentry><term><parameter>engine</parameter> :</term>
507
527
Implement the member function <link linkend="focus-out"><function>focus_out()</function></link> in extended class to receive this signal.
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>
512
532
</para><variablelist role="params">
513
533
<varlistentry><term><parameter>engine</parameter> :</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>
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.
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>
528
548
</para><variablelist role="params">
529
549
<varlistentry><term><parameter>engine</parameter> :</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>
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.
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>
544
564
</para><variablelist role="params">
545
565
<varlistentry><term><parameter>engine</parameter> :</term>
551
571
<indexterm zone="IBusEngine-process-key-event"><primary sortas="IBusEngine::process-key-event">IBusEngine::process-key-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="IBusEngine">IBusEngine</link> *engine,
552
572
<link linkend="guint">guint</link> keyval,
553
573
<link linkend="guint">guint</link> state,
574
<link linkend="guint">guint</link> arg3,
554
575
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
556
577
Emitted when a key event is received.
557
578
Implement the member function <link linkend="process-key-event"><function>process_key_event()</function></link> in extended class to receive this signal.
560
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
581
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
562
583
</para><variablelist role="params">
563
584
<varlistentry><term><parameter>engine</parameter> :</term>
581
602
Implement the member function <link linkend="property-activate"><function>property_activate()</function></link> in extended class to receive this signal.
584
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
605
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
586
607
</para><variablelist role="params">
587
608
<varlistentry><term><parameter>engine</parameter> :</term>
598
619
Implement the member function <link linkend="property-hide"><function>property_hide()</function></link> in extended class to receive this signal.
601
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
622
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
603
624
</para><variablelist role="params">
604
625
<varlistentry><term><parameter>engine</parameter> :</term>
615
636
Implement the member function <link linkend="property-side"><function>property_side()</function></link> in extended class to receive this signal.
618
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
639
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
620
641
</para><variablelist role="params">
621
642
<varlistentry><term><parameter>engine</parameter> :</term>
631
652
Implement the member function <link linkend="reset"><function>reset()</function></link> in extended class to receive this signal.
634
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
655
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
636
657
</para><variablelist role="params">
637
658
<varlistentry><term><parameter>engine</parameter> :</term>
648
669
Implement the member function <link linkend="set-capabilities"><function>set_capabilities()</function></link> in extended class to receive this signal.
651
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
672
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
653
674
</para><variablelist role="params">
654
675
<varlistentry><term><parameter>engine</parameter> :</term>
671
692
Implement the member function <link linkend="set-cursor-location"><function>set_cursor_location()</function></link> in extended class to receive this signal.
674
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because GtkDoc.</para></note></para>
695
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note></para>
676
697
</para><variablelist role="params">
677
698
<varlistentry><term><parameter>engine</parameter> :</term>