~ubuntu-branches/ubuntu/natty/empathy/natty-updates

« back to all changes in this revision

Viewing changes to docs/libempathy/html/libempathy-empathy-contact-list.html

  • Committer: Bazaar Package Importer
  • Author(s): Sjoerd Simons
  • Date: 2008-03-10 16:39:07 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20080310163907-tv41g2zmf0qqgi85
Tags: 0.22.0-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="libempathy Reference Manual">
8
8
<link rel="up" href="libempathy_api.html" title="libempathy API reference">
9
 
<link rel="prev" href="libempathy-EmpathyContactFactory.html" title="EmpathyContactFactory">
 
9
<link rel="prev" href="libempathy-empathy-contact-groups.html" title="empathy-contact-groups">
10
10
<link rel="next" href="EmpathyContactManager.html" title="EmpathyContactManager">
11
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
19
19
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
20
20
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
21
21
<tr valign="middle">
22
 
<td><a accesskey="p" href="libempathy-EmpathyContactFactory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
22
<td><a accesskey="p" href="libempathy-empathy-contact-groups.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
23
23
<td><a accesskey="u" href="libempathy_api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
24
24
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
25
25
<th width="100%" align="center">libempathy Reference Manual</th>
26
26
<td><a accesskey="n" href="EmpathyContactManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
27
27
</tr>
28
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id329739" class="shortcut">Top</a>
29
 
                  &#160;|&#160;
30
 
                  <a href="#id382756" class="shortcut">Description</a>
31
 
                  &#160;|&#160;
32
 
                  <a href="#id361220" class="shortcut">Object Hierarchy</a>
33
 
                  &#160;|&#160;
34
 
                  <a href="#id361245" class="shortcut">Prerequisites</a>
35
 
                  &#160;|&#160;
36
 
                  <a href="#id361266" class="shortcut">Known Implementations</a>
37
 
                  &#160;|&#160;
38
 
                  <a href="#id361300" class="shortcut">Signals</a></nobr></td></tr>
 
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id374554" class="shortcut">Top</a>
 
29
                  &#160;|&#160;
 
30
                  <a href="#id382489" class="shortcut">Description</a>
 
31
                  &#160;|&#160;
 
32
                  <a href="#id354150" class="shortcut">Object Hierarchy</a>
 
33
                  &#160;|&#160;
 
34
                  <a href="#id354175" class="shortcut">Prerequisites</a>
 
35
                  &#160;|&#160;
 
36
                  <a href="#id354196" class="shortcut">Known Implementations</a>
 
37
                  &#160;|&#160;
 
38
                  <a href="#id382454" class="shortcut">Signals</a></nobr></td></tr>
39
39
</table>
40
40
<div class="refentry" lang="en">
41
41
<a name="libempathy-empathy-contact-list"></a><div class="titlepage"></div>
42
42
<div class="refnamediv"><table width="100%"><tr>
43
43
<td valign="top">
44
44
<h2>
45
 
<a name="id329739"></a><span class="refentrytitle">empathy-contact-list</span>
 
45
<a name="id374554"></a><span class="refentrytitle">empathy-contact-list</span>
46
46
</h2>
47
47
<p>empathy-contact-list</p>
48
48
</td>
77
77
void                <a class="link" href="libempathy-empathy-contact-list.html#empathy-contact-list-rename-group">empathy_contact_list_rename_group</a>   (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
78
78
                                                         const gchar *old_group,
79
79
                                                         const gchar *new_group);
 
80
void                <a class="link" href="libempathy-empathy-contact-list.html#empathy-contact-list-remove-group">empathy_contact_list_remove_group</a>   (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
 
81
                                                         const gchar *group);
80
82
 
81
83
</pre>
82
84
</div>
83
85
<div class="refsect1" lang="en">
84
 
<a name="id361220"></a><h2>Object Hierarchy</h2>
 
86
<a name="id354150"></a><h2>Object Hierarchy</h2>
85
87
<pre class="synopsis">
86
88
 
87
89
  GInterface
89
91
</pre>
90
92
</div>
91
93
<div class="refsect1" lang="en">
92
 
<a name="id361245"></a><h2>Prerequisites</h2>
 
94
<a name="id354175"></a><h2>Prerequisites</h2>
93
95
<p>
94
96
EmpathyContactList requires
95
97
 GObject.</p>
96
98
</div>
97
99
<div class="refsect1" lang="en">
98
 
<a name="id361266"></a><h2>Known Implementations</h2>
 
100
<a name="id354196"></a><h2>Known Implementations</h2>
99
101
<p>
100
102
EmpathyContactList is implemented by
101
103
 <a class="link" href="EmpathyContactManager.html" title="EmpathyContactManager">EmpathyContactManager</a>,  <a class="link" href="EmpathyTpContactList.html" title="EmpathyTpContactList">EmpathyTpContactList</a> and  <a class="link" href="EmpathyTpChatroom.html" title="EmpathyTpChatroom">EmpathyTpChatroom</a>.</p>
102
104
</div>
103
105
<div class="refsect1" lang="en">
104
 
<a name="id361300"></a><h2>Signals</h2>
 
106
<a name="id382454"></a><h2>Signals</h2>
105
107
<pre class="synopsis">
106
108
 
107
109
  "<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList-groups-changed">groups-changed</a>"                                 : Run Last
110
112
</pre>
111
113
</div>
112
114
<div class="refsect1" lang="en">
113
 
<a name="id382756"></a><h2>Description</h2>
 
115
<a name="id382489"></a><h2>Description</h2>
114
116
<p>
115
117
 
116
118
</p>
117
119
</div>
118
120
<div class="refsect1" lang="en">
119
 
<a name="id382772"></a><h2>Details</h2>
 
121
<a name="id382505"></a><h2>Details</h2>
120
122
<div class="refsect2" lang="en">
121
 
<a name="id382782"></a><h3>
 
123
<a name="id382516"></a><h3>
122
124
<a name="EmpathyContactList-struct"></a>EmpathyContactList</h3>
123
 
<a class="indexterm" name="id382795"></a><pre class="programlisting">typedef struct _EmpathyContactList EmpathyContactList;</pre>
 
125
<a class="indexterm" name="id382528"></a><pre class="programlisting">typedef struct _EmpathyContactList EmpathyContactList;</pre>
124
126
<p>
125
127
 
126
128
</p>
127
129
</div>
128
130
<hr>
129
131
<div class="refsect2" lang="en">
130
 
<a name="id382810"></a><h3>
 
132
<a name="id382543"></a><h3>
131
133
<a name="EmpathyContactListIface"></a>EmpathyContactListIface</h3>
132
 
<a class="indexterm" name="id382822"></a><pre class="programlisting">typedef struct {
 
134
<a class="indexterm" name="id382555"></a><pre class="programlisting">typedef struct {
133
135
        GTypeInterface   base_iface;
134
136
 
135
137
        /* VTabled */
163
165
</div>
164
166
<hr>
165
167
<div class="refsect2" lang="en">
166
 
<a name="id382848"></a><h3>
 
168
<a name="id382581"></a><h3>
167
169
<a name="empathy-contact-list-add"></a>empathy_contact_list_add ()</h3>
168
 
<a class="indexterm" name="id382860"></a><pre class="programlisting">void                empathy_contact_list_add            (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
 
170
<a class="indexterm" name="id382593"></a><pre class="programlisting">void                empathy_contact_list_add            (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
169
171
                                                         <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
170
172
                                                         const gchar *message);</pre>
171
173
<p>
196
198
</div>
197
199
<hr>
198
200
<div class="refsect2" lang="en">
199
 
<a name="id382946"></a><h3>
 
201
<a name="id382679"></a><h3>
200
202
<a name="empathy-contact-list-remove"></a>empathy_contact_list_remove ()</h3>
201
 
<a class="indexterm" name="id382958"></a><pre class="programlisting">void                empathy_contact_list_remove         (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
 
203
<a class="indexterm" name="id382691"></a><pre class="programlisting">void                empathy_contact_list_remove         (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
202
204
                                                         <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
203
205
                                                         const gchar *message);</pre>
204
206
<p>
229
231
</div>
230
232
<hr>
231
233
<div class="refsect2" lang="en">
232
 
<a name="id383044"></a><h3>
 
234
<a name="id382777"></a><h3>
233
235
<a name="empathy-contact-list-get-members"></a>empathy_contact_list_get_members ()</h3>
234
 
<a class="indexterm" name="id383056"></a><pre class="programlisting">GList*              empathy_contact_list_get_members    (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);</pre>
 
236
<a class="indexterm" name="id382789"></a><pre class="programlisting">GList*              empathy_contact_list_get_members    (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);</pre>
235
237
<p>
236
238
 
237
239
</p>
255
257
</div>
256
258
<hr>
257
259
<div class="refsect2" lang="en">
258
 
<a name="id383112"></a><h3>
 
260
<a name="id382845"></a><h3>
259
261
<a name="empathy-contact-list-get-pendings"></a>empathy_contact_list_get_pendings ()</h3>
260
 
<a class="indexterm" name="id383124"></a><pre class="programlisting">GList*              empathy_contact_list_get_pendings   (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);</pre>
 
262
<a class="indexterm" name="id382857"></a><pre class="programlisting">GList*              empathy_contact_list_get_pendings   (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);</pre>
261
263
<p>
262
264
 
263
265
</p>
281
283
</div>
282
284
<hr>
283
285
<div class="refsect2" lang="en">
284
 
<a name="id383180"></a><h3>
 
286
<a name="id382913"></a><h3>
285
287
<a name="empathy-contact-list-get-all-groups"></a>empathy_contact_list_get_all_groups ()</h3>
286
 
<a class="indexterm" name="id383192"></a><pre class="programlisting">GList*              empathy_contact_list_get_all_groups (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);</pre>
 
288
<a class="indexterm" name="id382925"></a><pre class="programlisting">GList*              empathy_contact_list_get_all_groups (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);</pre>
287
289
<p>
288
290
 
289
291
</p>
307
309
</div>
308
310
<hr>
309
311
<div class="refsect2" lang="en">
310
 
<a name="id383248"></a><h3>
 
312
<a name="id382981"></a><h3>
311
313
<a name="empathy-contact-list-get-groups"></a>empathy_contact_list_get_groups ()</h3>
312
 
<a class="indexterm" name="id383260"></a><pre class="programlisting">GList*              empathy_contact_list_get_groups     (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
 
314
<a class="indexterm" name="id382993"></a><pre class="programlisting">GList*              empathy_contact_list_get_groups     (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
313
315
                                                         <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact);</pre>
314
316
<p>
315
317
 
339
341
</div>
340
342
<hr>
341
343
<div class="refsect2" lang="en">
342
 
<a name="id383336"></a><h3>
 
344
<a name="id383069"></a><h3>
343
345
<a name="empathy-contact-list-add-to-group"></a>empathy_contact_list_add_to_group ()</h3>
344
 
<a class="indexterm" name="id383348"></a><pre class="programlisting">void                empathy_contact_list_add_to_group   (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
 
346
<a class="indexterm" name="id383081"></a><pre class="programlisting">void                empathy_contact_list_add_to_group   (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
345
347
                                                         <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
346
348
                                                         const gchar *group);</pre>
347
349
<p>
372
374
</div>
373
375
<hr>
374
376
<div class="refsect2" lang="en">
375
 
<a name="id383434"></a><h3>
 
377
<a name="id383167"></a><h3>
376
378
<a name="empathy-contact-list-remove-from-group"></a>empathy_contact_list_remove_from_group ()</h3>
377
 
<a class="indexterm" name="id383446"></a><pre class="programlisting">void                empathy_contact_list_remove_from_group
 
379
<a class="indexterm" name="id383179"></a><pre class="programlisting">void                empathy_contact_list_remove_from_group
378
380
                                                        (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
379
381
                                                         <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
380
382
                                                         const gchar *group);</pre>
406
408
</div>
407
409
<hr>
408
410
<div class="refsect2" lang="en">
409
 
<a name="id383533"></a><h3>
 
411
<a name="id383266"></a><h3>
410
412
<a name="empathy-contact-list-rename-group"></a>empathy_contact_list_rename_group ()</h3>
411
 
<a class="indexterm" name="id383545"></a><pre class="programlisting">void                empathy_contact_list_rename_group   (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
 
413
<a class="indexterm" name="id383278"></a><pre class="programlisting">void                empathy_contact_list_rename_group   (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
412
414
                                                         const gchar *old_group,
413
415
                                                         const gchar *new_group);</pre>
414
416
<p>
437
439
</tbody>
438
440
</table></div>
439
441
</div>
 
442
<hr>
 
443
<div class="refsect2" lang="en">
 
444
<a name="id383364"></a><h3>
 
445
<a name="empathy-contact-list-remove-group"></a>empathy_contact_list_remove_group ()</h3>
 
446
<a class="indexterm" name="id383376"></a><pre class="programlisting">void                empathy_contact_list_remove_group   (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
 
447
                                                         const gchar *group);</pre>
 
448
<p>
 
449
 
 
450
</p>
 
451
<div class="variablelist"><table border="0">
 
452
<col align="left" valign="top">
 
453
<tbody>
 
454
<tr>
 
455
<td><p><span class="term"><em class="parameter"><code>list</code></em>&#160;:</span></p></td>
 
456
<td>
 
457
</td>
 
458
</tr>
 
459
<tr>
 
460
<td><p><span class="term"><em class="parameter"><code>group</code></em>&#160;:</span></p></td>
 
461
<td>
 
462
 
 
463
 
 
464
</td>
 
465
</tr>
 
466
</tbody>
 
467
</table></div>
 
468
</div>
440
469
</div>
441
470
<div class="refsect1" lang="en">
442
 
<a name="id383632"></a><h2>Signal Details</h2>
 
471
<a name="id383443"></a><h2>Signal Details</h2>
443
472
<div class="refsect2" lang="en">
444
 
<a name="id383643"></a><h3>
 
473
<a name="id383453"></a><h3>
445
474
<a name="EmpathyContactList-groups-changed"></a>The <code class="literal">"groups-changed"</code> signal</h3>
446
 
<a class="indexterm" name="id383658"></a><pre class="programlisting">void                user_function                      (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *empathycontactlist,
 
475
<a class="indexterm" name="id383468"></a><pre class="programlisting">void                user_function                      (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *empathycontactlist,
447
476
                                                        <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>     *arg1,
448
477
                                                        gchar              *arg2,
449
478
                                                        gboolean            arg3,
484
513
</div>
485
514
<hr>
486
515
<div class="refsect2" lang="en">
487
 
<a name="id383783"></a><h3>
 
516
<a name="id383594"></a><h3>
488
517
<a name="EmpathyContactList-members-changed"></a>The <code class="literal">"members-changed"</code> signal</h3>
489
 
<a class="indexterm" name="id383798"></a><pre class="programlisting">void                user_function                      (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *empathycontactlist,
 
518
<a class="indexterm" name="id383609"></a><pre class="programlisting">void                user_function                      (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *empathycontactlist,
490
519
                                                        <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>     *arg1,
491
520
                                                        <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>     *arg2,
492
521
                                                        guint               arg3,
539
568
</div>
540
569
<hr>
541
570
<div class="refsect2" lang="en">
542
 
<a name="id383964"></a><h3>
 
571
<a name="id383775"></a><h3>
543
572
<a name="EmpathyContactList-pendings-changed"></a>The <code class="literal">"pendings-changed"</code> signal</h3>
544
 
<a class="indexterm" name="id383979"></a><pre class="programlisting">void                user_function                      (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *empathycontactlist,
 
573
<a class="indexterm" name="id383790"></a><pre class="programlisting">void                user_function                      (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *empathycontactlist,
545
574
                                                        <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>     *arg1,
546
575
                                                        <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>     *arg2,
547
576
                                                        guint               arg3,
594
623
</div>
595
624
</div>
596
625
<div class="refsect1" lang="en">
597
 
<a name="id384148"></a><div class="refsect2" lang="en"><a name="id384149"></a></div>
 
626
<a name="id383960"></a><div class="refsect2" lang="en"><a name="id383961"></a></div>
598
627
<hr>
599
 
<div class="refsect2" lang="en"><a name="id384150"></a></div>
 
628
<div class="refsect2" lang="en"><a name="id383962"></a></div>
600
629
</div>
601
630
</div>
602
631
</body>