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

« back to all changes in this revision

Viewing changes to docs/reference/ibus/xml/ibuslookuptable.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
* 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:
30
30
                                                         <link linkend="IBusText">IBusText</link> *text);
31
31
<link linkend="IBusText">IBusText</link> *          <link linkend="ibus-lookup-table-get-candidate">ibus_lookup_table_get_candidate</link>     (<link linkend="IBusLookupTable">IBusLookupTable</link> *table,
32
32
                                                         <link linkend="guint">guint</link> index);
 
33
<link linkend="void">void</link>                <link linkend="ibus-lookup-table-append-label">ibus_lookup_table_append_label</link>      (<link linkend="IBusLookupTable">IBusLookupTable</link> *table,
 
34
                                                         <link linkend="IBusText">IBusText</link> *text);
 
35
<link linkend="IBusText">IBusText</link> *          <link linkend="ibus-lookup-table-get-label">ibus_lookup_table_get_label</link>         (<link linkend="IBusLookupTable">IBusLookupTable</link> *table,
 
36
                                                         <link linkend="guint">guint</link> index);
33
37
<link linkend="void">void</link>                <link linkend="ibus-lookup-table-set-cursor-pos">ibus_lookup_table_set_cursor_pos</link>    (<link linkend="IBusLookupTable">IBusLookupTable</link> *table,
34
38
                                                         <link linkend="guint">guint</link> cursor_pos);
35
39
<link linkend="guint">guint</link>               <link linkend="ibus-lookup-table-get-cursor-pos">ibus_lookup_table_get_cursor_pos</link>    (<link linkend="IBusLookupTable">IBusLookupTable</link> *table);
91
95
    gboolean round;
92
96
 
93
97
    GArray *candidates;
 
98
    GArray *labels;
94
99
} IBusLookupTable;
95
100
</programlisting>
96
101
<para>
122
127
<listitem><simpara> Candidate words/phrases/
123
128
</simpara></listitem>
124
129
</varlistentry>
 
130
<varlistentry>
 
131
<term><link linkend="GArray">GArray</link>&#160;*<structfield>labels</structfield>;</term>
 
132
<listitem><simpara>
 
133
</simpara></listitem>
 
134
</varlistentry>
125
135
</variablelist></refsect2>
126
136
<refsect2 id="ibus-lookup-table-new" role="function">
127
137
<title>ibus_lookup_table_new ()</title>
134
144
<para>
135
145
</para><variablelist role="params">
136
146
<varlistentry><term><parameter>page_size</parameter>&#160;:</term>
137
 
<listitem><simpara> number of candidate shown per page.
 
147
<listitem><simpara> number of candidate shown per page, the max value is 16.
138
148
</simpara></listitem></varlistentry>
139
149
<varlistentry><term><parameter>cursor_pos</parameter>&#160;:</term>
140
150
<listitem><simpara> position index of cursor.
180
190
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> IBusText at the given index; NULL if no such IBusText.
181
191
</simpara></listitem></varlistentry>
182
192
</variablelist></refsect2>
 
193
<refsect2 id="ibus-lookup-table-append-label" role="function">
 
194
<title>ibus_lookup_table_append_label ()</title>
 
195
<indexterm zone="ibus-lookup-table-append-label"><primary sortas="ibus_lookup_table_append_label">ibus_lookup_table_append_label</primary></indexterm><programlisting><link linkend="void">void</link>                ibus_lookup_table_append_label      (<link linkend="IBusLookupTable">IBusLookupTable</link> *table,
 
196
                                                         <link linkend="IBusText">IBusText</link> *text);</programlisting>
 
197
<para>
 
198
Append a candidate word/phrase to IBusLookupTable.</para>
 
199
<para>
 
200
</para><variablelist role="params">
 
201
<varlistentry><term><parameter>table</parameter>&#160;:</term>
 
202
<listitem><simpara> An IBusLookupTable.
 
203
</simpara></listitem></varlistentry>
 
204
<varlistentry><term><parameter>text</parameter>&#160;:</term>
 
205
<listitem><simpara> candidate word/phrase to be appended (in IBusText format).
 
206
</simpara></listitem></varlistentry>
 
207
</variablelist></refsect2>
 
208
<refsect2 id="ibus-lookup-table-get-label" role="function">
 
209
<title>ibus_lookup_table_get_label ()</title>
 
210
<indexterm zone="ibus-lookup-table-get-label"><primary sortas="ibus_lookup_table_get_label">ibus_lookup_table_get_label</primary></indexterm><programlisting><link linkend="IBusText">IBusText</link> *          ibus_lookup_table_get_label         (<link linkend="IBusLookupTable">IBusLookupTable</link> *table,
 
211
                                                         <link linkend="guint">guint</link> index);</programlisting>
 
212
<para>
 
213
Return IBusText at the given index.</para>
 
214
<para>
 
215
</para><variablelist role="params">
 
216
<varlistentry><term><parameter>table</parameter>&#160;:</term>
 
217
<listitem><simpara> An IBusLookupTable.
 
218
</simpara></listitem></varlistentry>
 
219
<varlistentry><term><parameter>index</parameter>&#160;:</term>
 
220
<listitem><simpara> Index in the Lookup table.
 
221
</simpara></listitem></varlistentry>
 
222
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> IBusText at the given index; NULL if no such IBusText.
 
223
</simpara></listitem></varlistentry>
 
224
</variablelist></refsect2>
183
225
<refsect2 id="ibus-lookup-table-set-cursor-pos" role="function">
184
226
<title>ibus_lookup_table_set_cursor_pos ()</title>
185
227
<indexterm zone="ibus-lookup-table-set-cursor-pos"><primary sortas="ibus_lookup_table_set_cursor_pos">ibus_lookup_table_set_cursor_pos</primary></indexterm><programlisting><link linkend="void">void</link>                ibus_lookup_table_set_cursor_pos    (<link linkend="IBusLookupTable">IBusLookupTable</link> *table,