← 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/ibuslookuptable.xml

  • Committer: Bazaar Package Importer
  • Author(s): LI Daobing
  • Date: 2009-07-23 20:22:09 UTC
  • mfrom: (1.1.4 upstream) (6.1.7 sid)
  • Revision ID: james.westby@ubuntu.com-20090723202209-bmgqa80g1umg8l2p
Tags: 1.2.0.20090723-1
new upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/ibus/xml/ibuslookuptable.xml
99
99
} IBusLookupTable;
100
100
</programlisting>
101
101
<para>
102
 
An IBusLookuptable stores the candidate words or phrases for users to choose from.</para>
 
102
An IBusLookuptable stores the candidate words or phrases for users to choose from.
 
103
Note that some input methods allow you to select candidate by pressing non-numeric
 
104
keys such as "asdfghjkl;".
 
105
Developers of these input methods should change the labels with
 
106
<link linkend="ibus-lookup-table-append-label"><function>ibus_lookup_table_append_label()</function></link>.</para>
103
107
<para>
104
108
</para><variablelist role="struct">
105
109
<varlistentry>
124
128
</varlistentry>
125
129
<varlistentry>
126
130
<term><link linkend="GArray">GArray</link>&#160;*<structfield>candidates</structfield>;</term>
127
 
<listitem><simpara> Candidate words/phrases/
 
131
<listitem><simpara> Candidate words/phrases.
128
132
</simpara></listitem>
129
133
</varlistentry>
130
134
<varlistentry>
131
135
<term><link linkend="GArray">GArray</link>&#160;*<structfield>labels</structfield>;</term>
132
 
<listitem><simpara>
 
136
<listitem><simpara> Candidate labels which identify individual candidates in the same page. Default is 1, 2, 3, 4 ...
133
137
</simpara></listitem>
134
138
</varlistentry>
135
139
</variablelist></refsect2>
195
199
<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
200
                                                         <link linkend="IBusText">IBusText</link> *text);</programlisting>
197
201
<para>
198
 
Append a candidate word/phrase to IBusLookupTable.</para>
 
202
Append a candidate word/phrase to IBusLookupTable.
 
203
This function is needed if the input method select candidate with
 
204
non-numeric keys such as "asdfghjkl;".</para>
199
205
<para>
200
206
</para><variablelist role="params">
201
207
<varlistentry><term><parameter>table</parameter>&#160;:</term>
202
208
<listitem><simpara> An IBusLookupTable.
203
209
</simpara></listitem></varlistentry>
204
210
<varlistentry><term><parameter>text</parameter>&#160;:</term>
205
 
<listitem><simpara> candidate word/phrase to be appended (in IBusText format).
 
211
<listitem><simpara> A candidate label to be appended (in IBusText format).
206
212
</simpara></listitem></varlistentry>
207
213
</variablelist></refsect2>
208
214
<refsect2 id="ibus-lookup-table-get-label" role="function">