← Back to branch summary

~joel-auterson/ubuntu/maverick/ibus/newmenuname

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): LI Daobing
  • Date: 2009-10-05 20:45:18 UTC
  • mfrom: (1.1.5 upstream) (6.1.15 sid)
  • Revision ID: james.westby@ubuntu.com-20091005204518-069vlwrl3r8v7bbr
Tags: 1.2.0.20090927-2
https://launchpad.net/bugs/188690
https://launchpad.net/bugs/432375
* create po template when build (LP: #188690)
  - debian/rules: updated.
  - debian/clean: remove pot file when clean.
* debian/control: build depends on python-rsvg (LP: #432375)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/ibus/xml/ibusattribute.xml
57
57
<title role="object_hierarchy.title">Object Hierarchy</title>
58
58
<synopsis>
59
59
  <link linkend="GObject">GObject</link>
60
 
   +----<link linkend="IBusObject">IBusObject</link>
61
 
         +----<link linkend="IBusSerializable">IBusSerializable</link>
62
 
               +----IBusAttribute
 
60
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
61
         +----<link linkend="IBusObject">IBusObject</link>
 
62
               +----<link linkend="IBusSerializable">IBusSerializable</link>
 
63
                     +----IBusAttribute
63
64
</synopsis>
64
65
<synopsis>
65
66
  <link linkend="GObject">GObject</link>
66
 
   +----<link linkend="IBusObject">IBusObject</link>
67
 
         +----<link linkend="IBusSerializable">IBusSerializable</link>
68
 
               +----IBusAttrList
 
67
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
68
         +----<link linkend="IBusObject">IBusObject</link>
 
69
               +----<link linkend="IBusSerializable">IBusSerializable</link>
 
70
                     +----IBusAttrList
69
71
</synopsis>
70
72
</refsect1>
71
73
 
91
93
<title>IBUS_TYPE_ATTR_LIST</title>
92
94
<indexterm zone="IBUS-TYPE-ATTR-LIST--CAPS"><primary sortas="IBUS_TYPE_ATTR_LIST">IBUS_TYPE_ATTR_LIST</primary></indexterm><programlisting>#define             IBUS_TYPE_ATTR_LIST</programlisting>
93
95
<para>
 
96
Return GType of IBus attribute list.</para>
 
97
<para>
94
98
</para></refsect2>
95
99
<refsect2 id="IBUS-ATTR-LIST--CAPS" role="macro">
96
100
<title>IBUS_ATTR_LIST()</title>
97
101
<indexterm zone="IBUS-ATTR-LIST--CAPS"><primary sortas="IBUS_ATTR_LIST">IBUS_ATTR_LIST</primary></indexterm><programlisting>#define             IBUS_ATTR_LIST(obj)</programlisting>
98
102
<para>
 
103
Casts an IBUS_ATTR_LIST or derived pointer into a (IBusAttrList*) pointer.
 
104
Depending on the current debugging level, this function may invoke
 
105
certain runtime checks to identify invalid casts.</para>
 
106
<para>
99
107
</para><variablelist role="params">
100
108
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
101
 
<listitem><simpara>
 
109
<listitem><simpara> An object which is subject to casting.
102
110
</simpara></listitem></varlistentry>
103
111
</variablelist></refsect2>
104
112
<refsect2 id="IBUS-ATTR-LIST-CLASS--CAPS" role="macro">
105
113
<title>IBUS_ATTR_LIST_CLASS()</title>
106
114
<indexterm zone="IBUS-ATTR-LIST-CLASS--CAPS"><primary sortas="IBUS_ATTR_LIST_CLASS">IBUS_ATTR_LIST_CLASS</primary></indexterm><programlisting>#define             IBUS_ATTR_LIST_CLASS(klass)</programlisting>
107
115
<para>
 
116
Casts a derived IBusAttrListClass structure into a IBusAttrListClass structure.</para>
 
117
<para>
108
118
</para><variablelist role="params">
109
119
<varlistentry><term><parameter>klass</parameter>&#160;:</term>
110
 
<listitem><simpara>
 
120
<listitem><simpara> A class to be casted.
111
121
</simpara></listitem></varlistentry>
112
122
</variablelist></refsect2>
113
123
<refsect2 id="IBUS-IS-ATTR-LIST--CAPS" role="macro">
114
124
<title>IBUS_IS_ATTR_LIST()</title>
115
125
<indexterm zone="IBUS-IS-ATTR-LIST--CAPS"><primary sortas="IBUS_IS_ATTR_LIST">IBUS_IS_ATTR_LIST</primary></indexterm><programlisting>#define             IBUS_IS_ATTR_LIST(obj)</programlisting>
116
126
<para>
 
127
Checks whether a valid GTypeInstance pointer is of type IBUS_ATTR_LIST.</para>
 
128
<para>
117
129
</para><variablelist role="params">
118
130
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
119
 
<listitem><simpara>
 
131
<listitem><simpara> Instance to check for being a IBUS_ATTR_LIST.
120
132
</simpara></listitem></varlistentry>
121
133
</variablelist></refsect2>
122
134
<refsect2 id="IBUS-IS-ATTR-LIST-CLASS--CAPS" role="macro">
123
135
<title>IBUS_IS_ATTR_LIST_CLASS()</title>
124
136
<indexterm zone="IBUS-IS-ATTR-LIST-CLASS--CAPS"><primary sortas="IBUS_IS_ATTR_LIST_CLASS">IBUS_IS_ATTR_LIST_CLASS</primary></indexterm><programlisting>#define             IBUS_IS_ATTR_LIST_CLASS(klass)</programlisting>
125
137
<para>
 
138
Checks whether class "is a" valid IBusAttrListClass structure of type IBUS_ATTR_LIST or derived.</para>
 
139
<para>
126
140
</para><variablelist role="params">
127
141
<varlistentry><term><parameter>klass</parameter>&#160;:</term>
128
 
<listitem><simpara>
 
142
<listitem><simpara> A class to be checked.
129
143
</simpara></listitem></varlistentry>
130
144
</variablelist></refsect2>
131
145
<refsect2 id="IBUS-ATTR-LIST-GET-CLASS--CAPS" role="macro">
132
146
<title>IBUS_ATTR_LIST_GET_CLASS()</title>
133
147
<indexterm zone="IBUS-ATTR-LIST-GET-CLASS--CAPS"><primary sortas="IBUS_ATTR_LIST_GET_CLASS">IBUS_ATTR_LIST_GET_CLASS</primary></indexterm><programlisting>#define             IBUS_ATTR_LIST_GET_CLASS(obj)</programlisting>
134
148
<para>
 
149
Get the class of a given object and cast the class to IBusAttrListClass.</para>
 
150
<para>
135
151
</para><variablelist role="params">
136
152
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
137
 
<listitem><simpara>
 
153
<listitem><simpara> An object.
138
154
</simpara></listitem></varlistentry>
139
155
</variablelist></refsect2>
140
156
<refsect2 id="IBusAttrType" role="enum">
146
162
} IBusAttrType;
147
163
</programlisting>
148
164
<para>
149
 
Type of IBusText attribute.</para>
 
165
Type enumeration of IBusText attribute.</para>
150
166
<para>
151
167
</para><variablelist role="enum">
152
168
<varlistentry id="IBUS-ATTR-TYPE-UNDERLINE--CAPS" role="constant">
172
188
    IBUS_ATTR_UNDERLINE_SINGLE  = 1,
173
189
    IBUS_ATTR_UNDERLINE_DOUBLE  = 2,
174
190
    IBUS_ATTR_UNDERLINE_LOW     = 3,
 
191
    IBUS_ATTR_UNDERLINE_ERROR   = 4,
175
192
} IBusAttrUnderline;
176
193
</programlisting>
177
194
<para>
198
215
<listitem><simpara> Low underline ? <link linkend="FIXME--CAPS"><literal>FIXME</literal></link>
199
216
</simpara></listitem>
200
217
</varlistentry>
 
218
<varlistentry id="IBUS-ATTR-UNDERLINE-ERROR--CAPS" role="constant">
 
219
<term><literal>IBUS_ATTR_UNDERLINE_ERROR</literal></term>
 
220
<listitem><simpara> Error underline
 
221
</simpara></listitem>
 
222
</varlistentry>
201
223
</variablelist></refsect2>
202
224
<refsect2 id="IBusAttribute-struct" role="struct">
203
225
<title>IBusAttribute</title>
363
385
<indexterm zone="ibus-attr-list-append"><primary sortas="ibus_attr_list_append">ibus_attr_list_append</primary></indexterm><programlisting><link linkend="void">void</link>                ibus_attr_list_append               (<link linkend="IBusAttrList">IBusAttrList</link> *attr_list,
364
386
                                                         <link linkend="IBusAttribute">IBusAttribute</link> *attr);</programlisting>
365
387
<para>
366
 
Append an IBusAttribute to IBusAttrList.</para>
 
388
Append an IBusAttribute to IBusAttrList, and increase reference.</para>
367
389
<para>
368
390
</para><variablelist role="params">
369
391
<varlistentry><term><parameter>attr_list</parameter>&#160;:</term>
378
400
<indexterm zone="ibus-attr-list-get"><primary sortas="ibus_attr_list_get">ibus_attr_list_get</primary></indexterm><programlisting><link linkend="IBusAttribute">IBusAttribute</link> *     ibus_attr_list_get                  (<link linkend="IBusAttrList">IBusAttrList</link> *attr_list,
379
401
                                                         <link linkend="guint">guint</link> index);</programlisting>
380
402
<para>
381
 
Returns IBusAttribute at given index.</para>
 
403
Returns IBusAttribute at given index. Borrowed reference.</para>
382
404
<para>
383
405
</para><variablelist role="params">
384
406
<varlistentry><term><parameter>attr_list</parameter>&#160;:</term>