← Back to branch summary

~ubuntu-branches/ubuntu/karmic/empathy/karmic

« back to all changes in this revision

Viewing changes to docs/libempathy/xml/empathy-utils.xml

  • Committer: Bazaar Package Importer
  • Author(s): Laurent Bigonville
  • Date: 2007-12-04 00:00:31 UTC
  • mto: (6.4.1 sid) (1.3.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 18.
  • Revision ID: james.westby@ubuntu.com-20071204000031-w2os396zoqdbcybt
Tags: upstream-0.21.3
Import upstream version 0.21.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libempathy/xml/empathy-utils.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
<!ENTITY version SYSTEM "version.xml">
 
5
]>
 
6
<refentry id="libempathy-empathy-utils">
 
7
<refmeta>
 
8
<refentrytitle role="top_of_page">empathy-utils</refentrytitle>
 
9
<manvolnum>3</manvolnum>
 
10
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
 
11
</refmeta>
 
12
 
 
13
<refnamediv>
 
14
<refname>empathy-utils</refname>
 
15
<refpurpose></refpurpose>
 
16
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
17
</refnamediv>
 
18
 
 
19
<refsynopsisdiv role="synopsis">
 
20
<title role="synopsis.title">Synopsis</title>
 
21
 
 
22
<synopsis>
 
23
 
 
24
 
 
25
 
 
26
#define             <link linkend="G-STR-EMPTY:CAPS">G_STR_EMPTY</link>                         (x)
 
27
enum                <link linkend="EmpathyRegExType">EmpathyRegExType</link>;
 
28
<link linkend="gchar">gchar</link>*              <link linkend="empathy-substring">empathy_substring</link>                   (const <link linkend="gchar">gchar</link> *str,
 
29
                                                         <link linkend="gint">gint</link> start,
 
30
                                                         <link linkend="gint">gint</link> end);
 
31
<link linkend="gint">gint</link>                <link linkend="empathy-regex-match">empathy_regex_match</link>                 (<link linkend="EmpathyRegExType">EmpathyRegExType</link> type,
 
32
                                                         const <link linkend="gchar">gchar</link> *msg,
 
33
                                                         <link linkend="GArray">GArray</link> *start,
 
34
                                                         <link linkend="GArray">GArray</link> *end);
 
35
<link linkend="gint">gint</link>                <link linkend="empathy-strcasecmp">empathy_strcasecmp</link>                  (const <link linkend="gchar">gchar</link> *s1,
 
36
                                                         const <link linkend="gchar">gchar</link> *s2);
 
37
<link linkend="gint">gint</link>                <link linkend="empathy-strncasecmp">empathy_strncasecmp</link>                 (const <link linkend="gchar">gchar</link> *s1,
 
38
                                                         const <link linkend="gchar">gchar</link> *s2,
 
39
                                                         <link linkend="gsize">gsize</link> n);
 
40
<link linkend="gboolean">gboolean</link>            <link linkend="empathy-xml-validate">empathy_xml_validate</link>                (<link linkend="xmlDoc">xmlDoc</link> *doc,
 
41
                                                         const <link linkend="gchar">gchar</link> *dtd_filename);
 
42
<link linkend="xmlNodePtr">xmlNodePtr</link>          <link linkend="empathy-xml-node-get-child">empathy_xml_node_get_child</link>          (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
 
43
                                                         const <link linkend="gchar">gchar</link> *child_name);
 
44
<link linkend="xmlChar">xmlChar</link>*            <link linkend="empathy-xml-node-get-child-content">empathy_xml_node_get_child_content</link>  (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
 
45
                                                         const <link linkend="gchar">gchar</link> *child_name);
 
46
<link linkend="xmlNodePtr">xmlNodePtr</link>          <link linkend="empathy-xml-node-find-child-prop-value">empathy_xml_node_find_child_prop_value</link>
 
47
                                                        (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
 
48
                                                         const <link linkend="gchar">gchar</link> *prop_name,
 
49
                                                         const <link linkend="gchar">gchar</link> *prop_value);
 
50
<link linkend="guint">guint</link>               <link linkend="empathy-account-hash">empathy_account_hash</link>                (<link linkend="gconstpointer">gconstpointer</link> key);
 
51
<link linkend="gboolean">gboolean</link>            <link linkend="empathy-account-equal">empathy_account_equal</link>               (<link linkend="gconstpointer">gconstpointer</link> a,
 
52
                                                         <link linkend="gconstpointer">gconstpointer</link> b);
 
53
<link linkend="MissionControl">MissionControl</link>*     <link linkend="empathy-mission-control-new">empathy_mission_control_new</link>         (void);
 
54
<link linkend="gchar">gchar</link>*              <link linkend="empathy-inspect-handle">empathy_inspect_handle</link>              (<link linkend="McAccount">McAccount</link> *account,
 
55
                                                         <link linkend="guint">guint</link> handle,
 
56
                                                         <link linkend="guint">guint</link> handle_type);
 
57
<link linkend="gchar">gchar</link>*              <link linkend="empathy-inspect-channel">empathy_inspect_channel</link>             (<link linkend="McAccount">McAccount</link> *account,
 
58
                                                         <link linkend="TpChan">TpChan</link> *tp_chan);
 
59
<link linkend="void">void</link>                <link linkend="empathy-call-contact">empathy_call_contact</link>                (<link linkend="EmpathyContact">EmpathyContact</link> *contact);
 
60
</synopsis>
 
61
</refsynopsisdiv>
 
62
 
 
63
 
 
64
 
 
65
 
 
66
 
 
67
 
 
68
 
 
69
 
 
70
 
 
71
<refsect1 role="desc">
 
72
<title role="desc.title">Description</title>
 
73
<para>
 
74
 
 
75
</para>
 
76
</refsect1>
 
77
 
 
78
<refsect1 role="details">
 
79
<title role="details.title">Details</title>
 
80
<refsect2>
 
81
<title><anchor id="G-STR-EMPTY:CAPS" role="macro"/>G_STR_EMPTY()</title>
 
82
<indexterm><primary>G_STR_EMPTY</primary></indexterm><programlisting>#define G_STR_EMPTY(x) ((x) == NULL || (x)[0] == '\0')
 
83
</programlisting>
 
84
<para>
 
85
 
 
86
</para><variablelist role="params">
 
87
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
88
<listitem><simpara>
 
89
 
 
90
 
 
91
</simpara></listitem></varlistentry>
 
92
</variablelist></refsect2>
 
93
<refsect2>
 
94
<title><anchor id="EmpathyRegExType" role="enum"/>enum EmpathyRegExType</title>
 
95
<indexterm><primary>EmpathyRegExType</primary></indexterm><programlisting>typedef enum {
 
96
        EMPATHY_REGEX_AS_IS,
 
97
        EMPATHY_REGEX_BROWSER,
 
98
        EMPATHY_REGEX_EMAIL,
 
99
        EMPATHY_REGEX_OTHER,
 
100
        EMPATHY_REGEX_ALL,
 
101
} EmpathyRegExType;
 
102
</programlisting>
 
103
<para>
 
104
 
 
105
</para></refsect2>
 
106
<refsect2>
 
107
<title><anchor id="empathy-substring" role="function"/>empathy_substring ()</title>
 
108
<indexterm><primary>empathy_substring</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              empathy_substring                   (const <link linkend="gchar">gchar</link> *str,
 
109
                                                         <link linkend="gint">gint</link> start,
 
110
                                                         <link linkend="gint">gint</link> end);</programlisting>
 
111
<para>
 
112
 
 
113
</para><variablelist role="params">
 
114
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
 
115
<listitem><simpara>
 
116
</simpara></listitem></varlistentry>
 
117
<varlistentry><term><parameter>start</parameter>&nbsp;:</term>
 
118
<listitem><simpara>
 
119
</simpara></listitem></varlistentry>
 
120
<varlistentry><term><parameter>end</parameter>&nbsp;:</term>
 
121
<listitem><simpara>
 
122
</simpara></listitem></varlistentry>
 
123
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
124
 
 
125
 
 
126
</simpara></listitem></varlistentry>
 
127
</variablelist></refsect2>
 
128
<refsect2>
 
129
<title><anchor id="empathy-regex-match" role="function"/>empathy_regex_match ()</title>
 
130
<indexterm><primary>empathy_regex_match</primary></indexterm><programlisting><link linkend="gint">gint</link>                empathy_regex_match                 (<link linkend="EmpathyRegExType">EmpathyRegExType</link> type,
 
131
                                                         const <link linkend="gchar">gchar</link> *msg,
 
132
                                                         <link linkend="GArray">GArray</link> *start,
 
133
                                                         <link linkend="GArray">GArray</link> *end);</programlisting>
 
134
<para>
 
135
 
 
136
</para><variablelist role="params">
 
137
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
 
138
<listitem><simpara>
 
139
</simpara></listitem></varlistentry>
 
140
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
141
<listitem><simpara>
 
142
</simpara></listitem></varlistentry>
 
143
<varlistentry><term><parameter>start</parameter>&nbsp;:</term>
 
144
<listitem><simpara>
 
145
</simpara></listitem></varlistentry>
 
146
<varlistentry><term><parameter>end</parameter>&nbsp;:</term>
 
147
<listitem><simpara>
 
148
</simpara></listitem></varlistentry>
 
149
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
150
 
 
151
 
 
152
</simpara></listitem></varlistentry>
 
153
</variablelist></refsect2>
 
154
<refsect2>
 
155
<title><anchor id="empathy-strcasecmp" role="function"/>empathy_strcasecmp ()</title>
 
156
<indexterm><primary>empathy_strcasecmp</primary></indexterm><programlisting><link linkend="gint">gint</link>                empathy_strcasecmp                  (const <link linkend="gchar">gchar</link> *s1,
 
157
                                                         const <link linkend="gchar">gchar</link> *s2);</programlisting>
 
158
<para>
 
159
 
 
160
</para><variablelist role="params">
 
161
<varlistentry><term><parameter>s1</parameter>&nbsp;:</term>
 
162
<listitem><simpara>
 
163
</simpara></listitem></varlistentry>
 
164
<varlistentry><term><parameter>s2</parameter>&nbsp;:</term>
 
165
<listitem><simpara>
 
166
</simpara></listitem></varlistentry>
 
167
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
168
 
 
169
 
 
170
</simpara></listitem></varlistentry>
 
171
</variablelist></refsect2>
 
172
<refsect2>
 
173
<title><anchor id="empathy-strncasecmp" role="function"/>empathy_strncasecmp ()</title>
 
174
<indexterm><primary>empathy_strncasecmp</primary></indexterm><programlisting><link linkend="gint">gint</link>                empathy_strncasecmp                 (const <link linkend="gchar">gchar</link> *s1,
 
175
                                                         const <link linkend="gchar">gchar</link> *s2,
 
176
                                                         <link linkend="gsize">gsize</link> n);</programlisting>
 
177
<para>
 
178
 
 
179
</para><variablelist role="params">
 
180
<varlistentry><term><parameter>s1</parameter>&nbsp;:</term>
 
181
<listitem><simpara>
 
182
</simpara></listitem></varlistentry>
 
183
<varlistentry><term><parameter>s2</parameter>&nbsp;:</term>
 
184
<listitem><simpara>
 
185
</simpara></listitem></varlistentry>
 
186
<varlistentry><term><parameter>n</parameter>&nbsp;:</term>
 
187
<listitem><simpara>
 
188
</simpara></listitem></varlistentry>
 
189
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
190
 
 
191
 
 
192
</simpara></listitem></varlistentry>
 
193
</variablelist></refsect2>
 
194
<refsect2>
 
195
<title><anchor id="empathy-xml-validate" role="function"/>empathy_xml_validate ()</title>
 
196
<indexterm><primary>empathy_xml_validate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            empathy_xml_validate                (<link linkend="xmlDoc">xmlDoc</link> *doc,
 
197
                                                         const <link linkend="gchar">gchar</link> *dtd_filename);</programlisting>
 
198
<para>
 
199
 
 
200
</para><variablelist role="params">
 
201
<varlistentry><term><parameter>doc</parameter>&nbsp;:</term>
 
202
<listitem><simpara>
 
203
</simpara></listitem></varlistentry>
 
204
<varlistentry><term><parameter>dtd_filename</parameter>&nbsp;:</term>
 
205
<listitem><simpara>
 
206
</simpara></listitem></varlistentry>
 
207
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
208
 
 
209
 
 
210
</simpara></listitem></varlistentry>
 
211
</variablelist></refsect2>
 
212
<refsect2>
 
213
<title><anchor id="empathy-xml-node-get-child" role="function"/>empathy_xml_node_get_child ()</title>
 
214
<indexterm><primary>empathy_xml_node_get_child</primary></indexterm><programlisting><link linkend="xmlNodePtr">xmlNodePtr</link>          empathy_xml_node_get_child          (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
 
215
                                                         const <link linkend="gchar">gchar</link> *child_name);</programlisting>
 
216
<para>
 
217
 
 
218
</para><variablelist role="params">
 
219
<varlistentry><term><parameter>node</parameter>&nbsp;:</term>
 
220
<listitem><simpara>
 
221
</simpara></listitem></varlistentry>
 
222
<varlistentry><term><parameter>child_name</parameter>&nbsp;:</term>
 
223
<listitem><simpara>
 
224
</simpara></listitem></varlistentry>
 
225
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
226
 
 
227
 
 
228
</simpara></listitem></varlistentry>
 
229
</variablelist></refsect2>
 
230
<refsect2>
 
231
<title><anchor id="empathy-xml-node-get-child-content" role="function"/>empathy_xml_node_get_child_content ()</title>
 
232
<indexterm><primary>empathy_xml_node_get_child_content</primary></indexterm><programlisting><link linkend="xmlChar">xmlChar</link>*            empathy_xml_node_get_child_content  (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
 
233
                                                         const <link linkend="gchar">gchar</link> *child_name);</programlisting>
 
234
<para>
 
235
 
 
236
</para><variablelist role="params">
 
237
<varlistentry><term><parameter>node</parameter>&nbsp;:</term>
 
238
<listitem><simpara>
 
239
</simpara></listitem></varlistentry>
 
240
<varlistentry><term><parameter>child_name</parameter>&nbsp;:</term>
 
241
<listitem><simpara>
 
242
</simpara></listitem></varlistentry>
 
243
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
244
 
 
245
 
 
246
</simpara></listitem></varlistentry>
 
247
</variablelist></refsect2>
 
248
<refsect2>
 
249
<title><anchor id="empathy-xml-node-find-child-prop-value" role="function"/>empathy_xml_node_find_child_prop_value ()</title>
 
250
<indexterm><primary>empathy_xml_node_find_child_prop_value</primary></indexterm><programlisting><link linkend="xmlNodePtr">xmlNodePtr</link>          empathy_xml_node_find_child_prop_value
 
251
                                                        (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
 
252
                                                         const <link linkend="gchar">gchar</link> *prop_name,
 
253
                                                         const <link linkend="gchar">gchar</link> *prop_value);</programlisting>
 
254
<para>
 
255
 
 
256
</para><variablelist role="params">
 
257
<varlistentry><term><parameter>node</parameter>&nbsp;:</term>
 
258
<listitem><simpara>
 
259
</simpara></listitem></varlistentry>
 
260
<varlistentry><term><parameter>prop_name</parameter>&nbsp;:</term>
 
261
<listitem><simpara>
 
262
</simpara></listitem></varlistentry>
 
263
<varlistentry><term><parameter>prop_value</parameter>&nbsp;:</term>
 
264
<listitem><simpara>
 
265
</simpara></listitem></varlistentry>
 
266
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
267
 
 
268
 
 
269
</simpara></listitem></varlistentry>
 
270
</variablelist></refsect2>
 
271
<refsect2>
 
272
<title><anchor id="empathy-account-hash" role="function"/>empathy_account_hash ()</title>
 
273
<indexterm><primary>empathy_account_hash</primary></indexterm><programlisting><link linkend="guint">guint</link>               empathy_account_hash                (<link linkend="gconstpointer">gconstpointer</link> key);</programlisting>
 
274
<para>
 
275
 
 
276
</para><variablelist role="params">
 
277
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
278
<listitem><simpara>
 
279
</simpara></listitem></varlistentry>
 
280
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
281
 
 
282
 
 
283
</simpara></listitem></varlistentry>
 
284
</variablelist></refsect2>
 
285
<refsect2>
 
286
<title><anchor id="empathy-account-equal" role="function"/>empathy_account_equal ()</title>
 
287
<indexterm><primary>empathy_account_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            empathy_account_equal               (<link linkend="gconstpointer">gconstpointer</link> a,
 
288
                                                         <link linkend="gconstpointer">gconstpointer</link> b);</programlisting>
 
289
<para>
 
290
 
 
291
</para><variablelist role="params">
 
292
<varlistentry><term><parameter>a</parameter>&nbsp;:</term>
 
293
<listitem><simpara>
 
294
</simpara></listitem></varlistentry>
 
295
<varlistentry><term><parameter>b</parameter>&nbsp;:</term>
 
296
<listitem><simpara>
 
297
</simpara></listitem></varlistentry>
 
298
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
299
 
 
300
 
 
301
</simpara></listitem></varlistentry>
 
302
</variablelist></refsect2>
 
303
<refsect2>
 
304
<title><anchor id="empathy-mission-control-new" role="function"/>empathy_mission_control_new ()</title>
 
305
<indexterm><primary>empathy_mission_control_new</primary></indexterm><programlisting><link linkend="MissionControl">MissionControl</link>*     empathy_mission_control_new         (void);</programlisting>
 
306
<para>
 
307
 
 
308
</para><variablelist role="params">
 
309
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
310
 
 
311
 
 
312
</simpara></listitem></varlistentry>
 
313
</variablelist></refsect2>
 
314
<refsect2>
 
315
<title><anchor id="empathy-inspect-handle" role="function"/>empathy_inspect_handle ()</title>
 
316
<indexterm><primary>empathy_inspect_handle</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              empathy_inspect_handle              (<link linkend="McAccount">McAccount</link> *account,
 
317
                                                         <link linkend="guint">guint</link> handle,
 
318
                                                         <link linkend="guint">guint</link> handle_type);</programlisting>
 
319
<para>
 
320
 
 
321
</para><variablelist role="params">
 
322
<varlistentry><term><parameter>account</parameter>&nbsp;:</term>
 
323
<listitem><simpara>
 
324
</simpara></listitem></varlistentry>
 
325
<varlistentry><term><parameter>handle</parameter>&nbsp;:</term>
 
326
<listitem><simpara>
 
327
</simpara></listitem></varlistentry>
 
328
<varlistentry><term><parameter>handle_type</parameter>&nbsp;:</term>
 
329
<listitem><simpara>
 
330
</simpara></listitem></varlistentry>
 
331
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
332
 
 
333
 
 
334
</simpara></listitem></varlistentry>
 
335
</variablelist></refsect2>
 
336
<refsect2>
 
337
<title><anchor id="empathy-inspect-channel" role="function"/>empathy_inspect_channel ()</title>
 
338
<indexterm><primary>empathy_inspect_channel</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              empathy_inspect_channel             (<link linkend="McAccount">McAccount</link> *account,
 
339
                                                         <link linkend="TpChan">TpChan</link> *tp_chan);</programlisting>
 
340
<para>
 
341
 
 
342
</para><variablelist role="params">
 
343
<varlistentry><term><parameter>account</parameter>&nbsp;:</term>
 
344
<listitem><simpara>
 
345
</simpara></listitem></varlistentry>
 
346
<varlistentry><term><parameter>tp_chan</parameter>&nbsp;:</term>
 
347
<listitem><simpara>
 
348
</simpara></listitem></varlistentry>
 
349
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
350
 
 
351
 
 
352
</simpara></listitem></varlistentry>
 
353
</variablelist></refsect2>
 
354
<refsect2>
 
355
<title><anchor id="empathy-call-contact" role="function"/>empathy_call_contact ()</title>
 
356
<indexterm><primary>empathy_call_contact</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_call_contact                (<link linkend="EmpathyContact">EmpathyContact</link> *contact);</programlisting>
 
357
<para>
 
358
 
 
359
</para><variablelist role="params">
 
360
<varlistentry><term><parameter>contact</parameter>&nbsp;:</term>
 
361
<listitem><simpara>
 
362
 
 
363
 
 
364
</simpara></listitem></varlistentry>
 
365
</variablelist></refsect2>
 
366
 
 
367
</refsect1>
 
368
 
 
369
 
 
370
 
 
371
 
 
372
 
 
373
<refsect1><refsect2 /><refsect2 /></refsect1>
 
374
</refentry>