← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/libempathy/html/EmpathyPresence.html

  • 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:
doc/libempathy/html/EmpathyPresence.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
 
<title>EmpathyPresence</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="libempathy Reference Manual">
8
 
<link rel="up" href="ch01.html" title="libempathy API reference">
9
 
<link rel="prev" href="EmpathyMessage.html" title="EmpathyMessage">
10
 
<link rel="next" href="EmpathyContact.html" title="EmpathyContact">
11
 
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="ch01.html" title="libempathy API reference">
14
 
</head>
15
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
 
<tr valign="middle">
18
 
<td><a accesskey="p" href="EmpathyMessage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19
 
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
 
<th width="100%" align="center">libempathy Reference Manual</th>
22
 
<td><a accesskey="n" href="EmpathyContact.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
 
</tr>
24
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id363172" class="shortcut">Top</a>
25
 
                  &#160;|&#160;
26
 
                  <a href="#id343014" class="shortcut">Description</a>
27
 
                  &#160;|&#160;
28
 
                  <a href="#id342948" class="shortcut">Object Hierarchy</a>
29
 
                  &#160;|&#160;
30
 
                  <a href="#id342972" class="shortcut">Properties</a></nobr></td></tr>
31
 
</table>
32
 
<div class="refentry" lang="en">
33
 
<a name="EmpathyPresence"></a><div class="titlepage"></div>
34
 
<div class="refnamediv"><table width="100%"><tr>
35
 
<td valign="top">
36
 
<h2>
37
 
<a name="id363172"></a><span class="refentrytitle">EmpathyPresence</span>
38
 
</h2>
39
 
<p>EmpathyPresence</p>
40
 
</td>
41
 
<td valign="top" align="right"></td>
42
 
</tr></table></div>
43
 
<div class="refsynopsisdiv">
44
 
<h2>Synopsis</h2>
45
 
<pre class="synopsis">
46
 
 
47
 
 
48
 
 
49
 
                    <a class="link" href="EmpathyPresence.html#EmpathyPresence-struct">EmpathyPresence</a>;
50
 
<a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a>*    <a class="link" href="EmpathyPresence.html#empathy-presence-new">empathy_presence_new</a>                (void);
51
 
<a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a>*    <a class="link" href="EmpathyPresence.html#empathy-presence-new-full">empathy_presence_new_full</a>           (<a
52
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
53
 
>McPresence</a> state,
54
 
                                                         const gchar *status);
55
 
<a
56
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
57
 
>McPresence</a>          <a class="link" href="EmpathyPresence.html#empathy-presence-get-state">empathy_presence_get_state</a>          (<a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a> *presence);
58
 
const gchar*        <a class="link" href="EmpathyPresence.html#empathy-presence-get-status">empathy_presence_get_status</a>         (<a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a> *presence);
59
 
void                <a class="link" href="EmpathyPresence.html#empathy-presence-set-state">empathy_presence_set_state</a>          (<a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a> *presence,
60
 
                                                         <a
61
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
62
 
>McPresence</a> state);
63
 
void                <a class="link" href="EmpathyPresence.html#empathy-presence-set-status">empathy_presence_set_status</a>         (<a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a> *presence,
64
 
                                                         const gchar *status);
65
 
gint                <a class="link" href="EmpathyPresence.html#empathy-presence-sort-func">empathy_presence_sort_func</a>          (gconstpointer a,
66
 
                                                         gconstpointer b);
67
 
const gchar*        <a class="link" href="EmpathyPresence.html#empathy-presence-state-get-default-status">empathy_presence_state_get_default_status</a>
68
 
                                                        (<a
69
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
70
 
>McPresence</a> state);
71
 
const gchar*        <a class="link" href="EmpathyPresence.html#empathy-presence-state-to-str">empathy_presence_state_to_str</a>       (<a
72
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
73
 
>McPresence</a> state);
74
 
<a
75
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
76
 
>McPresence</a>          <a class="link" href="EmpathyPresence.html#empathy-presence-state-from-str">empathy_presence_state_from_str</a>     (const gchar *str);
77
 
 
78
 
</pre>
79
 
</div>
80
 
<div class="refsect1" lang="en">
81
 
<a name="id342948"></a><h2>Object Hierarchy</h2>
82
 
<pre class="synopsis">
83
 
 
84
 
  GObject
85
 
   +----EmpathyPresence
86
 
</pre>
87
 
</div>
88
 
<div class="refsect1" lang="en">
89
 
<a name="id342972"></a><h2>Properties</h2>
90
 
<pre class="synopsis">
91
 
 
92
 
  "<a class="link" href="EmpathyPresence.html#EmpathyPresence--state">state</a>"                    <a
93
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
94
 
>McPresence</a>            : Read / Write
95
 
  "<a class="link" href="EmpathyPresence.html#EmpathyPresence--status">status</a>"                   gchararray            : Read / Write
96
 
</pre>
97
 
</div>
98
 
<div class="refsect1" lang="en">
99
 
<a name="id343014"></a><h2>Description</h2>
100
 
<p>
101
 
 
102
 
</p>
103
 
</div>
104
 
<div class="refsect1" lang="en">
105
 
<a name="id343029"></a><h2>Details</h2>
106
 
<div class="refsect2" lang="en">
107
 
<a name="id343040"></a><h3>
108
 
<a name="EmpathyPresence-struct"></a>EmpathyPresence</h3>
109
 
<a class="indexterm" name="id343052"></a><pre class="programlisting">typedef struct _EmpathyPresence EmpathyPresence;</pre>
110
 
<p>
111
 
 
112
 
</p>
113
 
</div>
114
 
<hr>
115
 
<div class="refsect2" lang="en">
116
 
<a name="id367457"></a><h3>
117
 
<a name="empathy-presence-new"></a>empathy_presence_new ()</h3>
118
 
<a class="indexterm" name="id367469"></a><pre class="programlisting"><a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a>*    empathy_presence_new                (void);</pre>
119
 
<p>
120
 
 
121
 
</p>
122
 
<div class="variablelist"><table border="0">
123
 
<col align="left" valign="top">
124
 
<tbody><tr>
125
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
126
 
<td>
127
 
 
128
 
 
129
 
</td>
130
 
</tr></tbody>
131
 
</table></div>
132
 
</div>
133
 
<hr>
134
 
<div class="refsect2" lang="en">
135
 
<a name="id367504"></a><h3>
136
 
<a name="empathy-presence-new-full"></a>empathy_presence_new_full ()</h3>
137
 
<a class="indexterm" name="id367516"></a><pre class="programlisting"><a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a>*    empathy_presence_new_full           (<a
138
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
139
 
>McPresence</a> state,
140
 
                                                         const gchar *status);</pre>
141
 
<p>
142
 
 
143
 
</p>
144
 
<div class="variablelist"><table border="0">
145
 
<col align="left" valign="top">
146
 
<tbody>
147
 
<tr>
148
 
<td><p><span class="term"><em class="parameter"><code>state</code></em>&#160;:</span></p></td>
149
 
<td>
150
 
</td>
151
 
</tr>
152
 
<tr>
153
 
<td><p><span class="term"><em class="parameter"><code>status</code></em>&#160;:</span></p></td>
154
 
<td>
155
 
</td>
156
 
</tr>
157
 
<tr>
158
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
159
 
<td>
160
 
 
161
 
 
162
 
</td>
163
 
</tr>
164
 
</tbody>
165
 
</table></div>
166
 
</div>
167
 
<hr>
168
 
<div class="refsect2" lang="en">
169
 
<a name="id367592"></a><h3>
170
 
<a name="empathy-presence-get-state"></a>empathy_presence_get_state ()</h3>
171
 
<a class="indexterm" name="id367604"></a><pre class="programlisting"><a
172
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
173
 
>McPresence</a>          empathy_presence_get_state          (<a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a> *presence);</pre>
174
 
<p>
175
 
 
176
 
</p>
177
 
<div class="variablelist"><table border="0">
178
 
<col align="left" valign="top">
179
 
<tbody>
180
 
<tr>
181
 
<td><p><span class="term"><em class="parameter"><code>presence</code></em>&#160;:</span></p></td>
182
 
<td>
183
 
</td>
184
 
</tr>
185
 
<tr>
186
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
187
 
<td>
188
 
 
189
 
 
190
 
</td>
191
 
</tr>
192
 
</tbody>
193
 
</table></div>
194
 
</div>
195
 
<hr>
196
 
<div class="refsect2" lang="en">
197
 
<a name="id367660"></a><h3>
198
 
<a name="empathy-presence-get-status"></a>empathy_presence_get_status ()</h3>
199
 
<a class="indexterm" name="id367672"></a><pre class="programlisting">const gchar*        empathy_presence_get_status         (<a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a> *presence);</pre>
200
 
<p>
201
 
 
202
 
</p>
203
 
<div class="variablelist"><table border="0">
204
 
<col align="left" valign="top">
205
 
<tbody>
206
 
<tr>
207
 
<td><p><span class="term"><em class="parameter"><code>presence</code></em>&#160;:</span></p></td>
208
 
<td>
209
 
</td>
210
 
</tr>
211
 
<tr>
212
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
213
 
<td>
214
 
 
215
 
 
216
 
</td>
217
 
</tr>
218
 
</tbody>
219
 
</table></div>
220
 
</div>
221
 
<hr>
222
 
<div class="refsect2" lang="en">
223
 
<a name="id383538"></a><h3>
224
 
<a name="empathy-presence-set-state"></a>empathy_presence_set_state ()</h3>
225
 
<a class="indexterm" name="id383548"></a><pre class="programlisting">void                empathy_presence_set_state          (<a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a> *presence,
226
 
                                                         <a
227
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
228
 
>McPresence</a> state);</pre>
229
 
<p>
230
 
 
231
 
</p>
232
 
<div class="variablelist"><table border="0">
233
 
<col align="left" valign="top">
234
 
<tbody>
235
 
<tr>
236
 
<td><p><span class="term"><em class="parameter"><code>presence</code></em>&#160;:</span></p></td>
237
 
<td>
238
 
</td>
239
 
</tr>
240
 
<tr>
241
 
<td><p><span class="term"><em class="parameter"><code>state</code></em>&#160;:</span></p></td>
242
 
<td>
243
 
 
244
 
 
245
 
</td>
246
 
</tr>
247
 
</tbody>
248
 
</table></div>
249
 
</div>
250
 
<hr>
251
 
<div class="refsect2" lang="en">
252
 
<a name="id383613"></a><h3>
253
 
<a name="empathy-presence-set-status"></a>empathy_presence_set_status ()</h3>
254
 
<a class="indexterm" name="id383626"></a><pre class="programlisting">void                empathy_presence_set_status         (<a class="link" href="EmpathyPresence.html" title="EmpathyPresence">EmpathyPresence</a> *presence,
255
 
                                                         const gchar *status);</pre>
256
 
<p>
257
 
 
258
 
</p>
259
 
<div class="variablelist"><table border="0">
260
 
<col align="left" valign="top">
261
 
<tbody>
262
 
<tr>
263
 
<td><p><span class="term"><em class="parameter"><code>presence</code></em>&#160;:</span></p></td>
264
 
<td>
265
 
</td>
266
 
</tr>
267
 
<tr>
268
 
<td><p><span class="term"><em class="parameter"><code>status</code></em>&#160;:</span></p></td>
269
 
<td>
270
 
 
271
 
 
272
 
</td>
273
 
</tr>
274
 
</tbody>
275
 
</table></div>
276
 
</div>
277
 
<hr>
278
 
<div class="refsect2" lang="en">
279
 
<a name="id383691"></a><h3>
280
 
<a name="empathy-presence-sort-func"></a>empathy_presence_sort_func ()</h3>
281
 
<a class="indexterm" name="id383704"></a><pre class="programlisting">gint                empathy_presence_sort_func          (gconstpointer a,
282
 
                                                         gconstpointer b);</pre>
283
 
<p>
284
 
 
285
 
</p>
286
 
<div class="variablelist"><table border="0">
287
 
<col align="left" valign="top">
288
 
<tbody>
289
 
<tr>
290
 
<td><p><span class="term"><em class="parameter"><code>a</code></em>&#160;:</span></p></td>
291
 
<td>
292
 
</td>
293
 
</tr>
294
 
<tr>
295
 
<td><p><span class="term"><em class="parameter"><code>b</code></em>&#160;:</span></p></td>
296
 
<td>
297
 
</td>
298
 
</tr>
299
 
<tr>
300
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
301
 
<td>
302
 
 
303
 
 
304
 
</td>
305
 
</tr>
306
 
</tbody>
307
 
</table></div>
308
 
</div>
309
 
<hr>
310
 
<div class="refsect2" lang="en">
311
 
<a name="id383780"></a><h3>
312
 
<a name="empathy-presence-state-get-default-status"></a>empathy_presence_state_get_default_status ()</h3>
313
 
<a class="indexterm" name="id383791"></a><pre class="programlisting">const gchar*        empathy_presence_state_get_default_status
314
 
                                                        (<a
315
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
316
 
>McPresence</a> state);</pre>
317
 
<p>
318
 
 
319
 
</p>
320
 
<div class="variablelist"><table border="0">
321
 
<col align="left" valign="top">
322
 
<tbody>
323
 
<tr>
324
 
<td><p><span class="term"><em class="parameter"><code>state</code></em>&#160;:</span></p></td>
325
 
<td>
326
 
</td>
327
 
</tr>
328
 
<tr>
329
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
330
 
<td>
331
 
 
332
 
 
333
 
</td>
334
 
</tr>
335
 
</tbody>
336
 
</table></div>
337
 
</div>
338
 
<hr>
339
 
<div class="refsect2" lang="en">
340
 
<a name="id383849"></a><h3>
341
 
<a name="empathy-presence-state-to-str"></a>empathy_presence_state_to_str ()</h3>
342
 
<a class="indexterm" name="id383861"></a><pre class="programlisting">const gchar*        empathy_presence_state_to_str       (<a
343
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
344
 
>McPresence</a> state);</pre>
345
 
<p>
346
 
 
347
 
</p>
348
 
<div class="variablelist"><table border="0">
349
 
<col align="left" valign="top">
350
 
<tbody>
351
 
<tr>
352
 
<td><p><span class="term"><em class="parameter"><code>state</code></em>&#160;:</span></p></td>
353
 
<td>
354
 
</td>
355
 
</tr>
356
 
<tr>
357
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
358
 
<td>
359
 
 
360
 
 
361
 
</td>
362
 
</tr>
363
 
</tbody>
364
 
</table></div>
365
 
</div>
366
 
<hr>
367
 
<div class="refsect2" lang="en">
368
 
<a name="id383918"></a><h3>
369
 
<a name="empathy-presence-state-from-str"></a>empathy_presence_state_from_str ()</h3>
370
 
<a class="indexterm" name="id383931"></a><pre class="programlisting"><a
371
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
372
 
>McPresence</a>          empathy_presence_state_from_str     (const gchar *str);</pre>
373
 
<p>
374
 
 
375
 
</p>
376
 
<div class="variablelist"><table border="0">
377
 
<col align="left" valign="top">
378
 
<tbody>
379
 
<tr>
380
 
<td><p><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></p></td>
381
 
<td>
382
 
</td>
383
 
</tr>
384
 
<tr>
385
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
386
 
<td>
387
 
 
388
 
 
389
 
</td>
390
 
</tr>
391
 
</tbody>
392
 
</table></div>
393
 
</div>
394
 
</div>
395
 
<div class="refsect1" lang="en">
396
 
<a name="id383988"></a><h2>Property Details</h2>
397
 
<div class="refsect2" lang="en">
398
 
<a name="id383998"></a><h3>
399
 
<a name="EmpathyPresence--state"></a>The <code class="literal">"state"</code> property</h3>
400
 
<a class="indexterm" name="id384013"></a><pre class="programlisting">  "state"                    <a
401
 
href="/usr/share/gtk-doc/html/libmissioncontrol/libmissioncontrol-mission-control.html#McPresence"
402
 
>McPresence</a>            : Read / Write</pre>
403
 
<p>The current state of the presence.</p>
404
 
<p>Default value: MC_PRESENCE_AVAILABLE</p>
405
 
</div>
406
 
<hr>
407
 
<div class="refsect2" lang="en">
408
 
<a name="id384038"></a><h3>
409
 
<a name="EmpathyPresence--status"></a>The <code class="literal">"status"</code> property</h3>
410
 
<a class="indexterm" name="id384053"></a><pre class="programlisting">  "status"                   gchararray            : Read / Write</pre>
411
 
<p>Status string set on presence.</p>
412
 
<p>Default value: NULL</p>
413
 
</div>
414
 
</div>
415
 
<div class="refsect1" lang="en">
416
 
<a name="id384080"></a><div class="refsect2" lang="en"><a name="id384081"></a></div>
417
 
<hr>
418
 
<div class="refsect2" lang="en"><a name="id384082"></a></div>
419
 
</div>
420
 
</div>
421
 
</body>
422
 
</html>