1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
<title>empathy-contact-list</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="EmpathyContact.html" title="EmpathyContact">
10
<link rel="next" href="EmpathyTpGroup.html" title="EmpathyTpGroup">
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">
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">
18
<td><a accesskey="p" href="EmpathyContact.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="EmpathyTpGroup.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
24
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id345553" class="shortcut">Top</a>
26
<a href="#id346324" class="shortcut">Description</a>
28
<a href="#id385978" class="shortcut">Object Hierarchy</a>
30
<a href="#id386002" class="shortcut">Known Implementations</a>
32
<a href="#id346289" class="shortcut">Signals</a></nobr></td></tr>
34
<div class="refentry" lang="en">
35
<a name="libempathy-empathy-contact-list"></a><div class="titlepage"></div>
36
<div class="refnamediv"><table width="100%"><tr>
39
<a name="id345553"></a><span class="refentrytitle">empathy-contact-list</span>
41
<p>empathy-contact-list</p>
43
<td valign="top" align="right"></td>
45
<div class="refsynopsisdiv">
47
<a name="EmpathyContactList"></a><pre class="synopsis">
51
<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList-struct">EmpathyContactList</a>;
52
<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactListIface">EmpathyContactListIface</a>;
53
void <a class="link" href="libempathy-empathy-contact-list.html#empathy-contact-list-add">empathy_contact_list_add</a> (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
54
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
55
const gchar *message);
56
void <a class="link" href="libempathy-empathy-contact-list.html#empathy-contact-list-remove">empathy_contact_list_remove</a> (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
57
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
58
const gchar *message);
59
GList* <a class="link" href="libempathy-empathy-contact-list.html#empathy-contact-list-get-members">empathy_contact_list_get_members</a> (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);
60
GList* <a class="link" href="libempathy-empathy-contact-list.html#empathy-contact-list-get-pendings">empathy_contact_list_get_pendings</a> (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);
61
GList* <a class="link" href="libempathy-empathy-contact-list.html#empathy-contact-list-get-all-groups">empathy_contact_list_get_all_groups</a> (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);
62
GList* <a class="link" href="libempathy-empathy-contact-list.html#empathy-contact-list-get-groups">empathy_contact_list_get_groups</a> (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
63
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact);
64
void <a class="link" href="libempathy-empathy-contact-list.html#empathy-contact-list-add-to-group">empathy_contact_list_add_to_group</a> (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
65
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
67
void <a class="link" href="libempathy-empathy-contact-list.html#empathy-contact-list-remove-from-group">empathy_contact_list_remove_from_group</a>
68
(<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
69
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
71
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,
72
const gchar *old_group,
73
const gchar *new_group);
77
<div class="refsect1" lang="en">
78
<a name="id385978"></a><h2>Object Hierarchy</h2>
79
<pre class="synopsis">
82
+----EmpathyContactList
85
<div class="refsect1" lang="en">
86
<a name="id386002"></a><h2>Known Implementations</h2>
88
EmpathyContactList is implemented by
89
EmpathyContactManager, <a class="link" href="EmpathyTpContactList.html" title="EmpathyTpContactList">EmpathyTpContactList</a> and <a class="link" href="EmpathyTpChatroom.html" title="EmpathyTpChatroom">EmpathyTpChatroom</a>.</p>
91
<div class="refsect1" lang="en">
92
<a name="id346289"></a><h2>Signals</h2>
93
<pre class="synopsis">
95
"<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList-groups-changed">groups-changed</a>" : Run Last
96
"<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList-members-changed">members-changed</a>" : Run Last
97
"<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList-pendings-changed">pendings-changed</a>" : Run Last
100
<div class="refsect1" lang="en">
101
<a name="id346324"></a><h2>Description</h2>
106
<div class="refsect1" lang="en">
107
<a name="id346340"></a><h2>Details</h2>
108
<div class="refsect2" lang="en">
109
<a name="id346351"></a><h3>
110
<a name="EmpathyContactList-struct"></a>EmpathyContactList</h3>
111
<a class="indexterm" name="id346363"></a><pre class="programlisting">typedef struct _EmpathyContactList EmpathyContactList;</pre>
117
<div class="refsect2" lang="en">
118
<a name="id346378"></a><h3>
119
<a name="EmpathyContactListIface"></a>EmpathyContactListIface</h3>
120
<a class="indexterm" name="id346390"></a><pre class="programlisting">typedef struct {
121
GTypeInterface base_iface;
124
void (*add) (EmpathyContactList *list,
125
EmpathyContact *contact,
126
const gchar *message);
127
void (*remove) (EmpathyContactList *list,
128
EmpathyContact *contact,
129
const gchar *message);
130
GList * (*get_members) (EmpathyContactList *list);
131
GList * (*get_pendings) (EmpathyContactList *list);
132
GList * (*get_all_groups) (EmpathyContactList *list);
133
GList * (*get_groups) (EmpathyContactList *list,
134
EmpathyContact *contact);
135
void (*add_to_group) (EmpathyContactList *list,
136
EmpathyContact *contact,
138
void (*remove_from_group) (EmpathyContactList *list,
139
EmpathyContact *contact,
141
void (*rename_group) (EmpathyContactList *list,
142
const gchar *old_group,
143
const gchar *new_group);
144
} EmpathyContactListIface;
151
<div class="refsect2" lang="en">
152
<a name="id376614"></a><h3>
153
<a name="empathy-contact-list-add"></a>empathy_contact_list_add ()</h3>
154
<a class="indexterm" name="id356818"></a><pre class="programlisting">void empathy_contact_list_add (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
155
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
156
const gchar *message);</pre>
160
<div class="variablelist"><table border="0">
161
<col align="left" valign="top">
164
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
169
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
174
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
184
<div class="refsect2" lang="en">
185
<a name="id386108"></a><h3>
186
<a name="empathy-contact-list-remove"></a>empathy_contact_list_remove ()</h3>
187
<a class="indexterm" name="id386120"></a><pre class="programlisting">void empathy_contact_list_remove (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
188
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
189
const gchar *message);</pre>
193
<div class="variablelist"><table border="0">
194
<col align="left" valign="top">
197
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
202
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
207
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
217
<div class="refsect2" lang="en">
218
<a name="id386206"></a><h3>
219
<a name="empathy-contact-list-get-members"></a>empathy_contact_list_get_members ()</h3>
220
<a class="indexterm" name="id386219"></a><pre class="programlisting">GList* empathy_contact_list_get_members (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);</pre>
224
<div class="variablelist"><table border="0">
225
<col align="left" valign="top">
228
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
233
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
243
<div class="refsect2" lang="en">
244
<a name="id386274"></a><h3>
245
<a name="empathy-contact-list-get-pendings"></a>empathy_contact_list_get_pendings ()</h3>
246
<a class="indexterm" name="id388355"></a><pre class="programlisting">GList* empathy_contact_list_get_pendings (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list);</pre>
250
<div class="variablelist"><table border="0">
251
<col align="left" valign="top">
254
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
259
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
269
<div class="refsect2" lang="en">
270
<a name="id388405"></a><h3>
271
<a name="empathy-contact-list-get-all-groups"></a>empathy_contact_list_get_all_groups ()</h3>
272
<a class="indexterm" name="id388415"></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>
276
<div class="variablelist"><table border="0">
277
<col align="left" valign="top">
280
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
285
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
295
<div class="refsect2" lang="en">
296
<a name="id388464"></a><h3>
297
<a name="empathy-contact-list-get-groups"></a>empathy_contact_list_get_groups ()</h3>
298
<a class="indexterm" name="id388475"></a><pre class="programlisting">GList* empathy_contact_list_get_groups (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
299
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact);</pre>
303
<div class="variablelist"><table border="0">
304
<col align="left" valign="top">
307
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
312
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
317
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
327
<div class="refsect2" lang="en">
328
<a name="id388542"></a><h3>
329
<a name="empathy-contact-list-add-to-group"></a>empathy_contact_list_add_to_group ()</h3>
330
<a class="indexterm" name="id388552"></a><pre class="programlisting">void empathy_contact_list_add_to_group (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
331
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
332
const gchar *group);</pre>
336
<div class="variablelist"><table border="0">
337
<col align="left" valign="top">
340
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
345
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
350
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
360
<div class="refsect2" lang="en">
361
<a name="id388629"></a><h3>
362
<a name="empathy-contact-list-remove-from-group"></a>empathy_contact_list_remove_from_group ()</h3>
363
<a class="indexterm" name="id388640"></a><pre class="programlisting">void empathy_contact_list_remove_from_group
364
(<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
365
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact,
366
const gchar *group);</pre>
370
<div class="variablelist"><table border="0">
371
<col align="left" valign="top">
374
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
379
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
384
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
394
<div class="refsect2" lang="en">
395
<a name="id388718"></a><h3>
396
<a name="empathy-contact-list-rename-group"></a>empathy_contact_list_rename_group ()</h3>
397
<a class="indexterm" name="id388728"></a><pre class="programlisting">void empathy_contact_list_rename_group (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *list,
398
const gchar *old_group,
399
const gchar *new_group);</pre>
403
<div class="variablelist"><table border="0">
404
<col align="left" valign="top">
407
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
412
<td><p><span class="term"><em class="parameter"><code>old_group</code></em> :</span></p></td>
417
<td><p><span class="term"><em class="parameter"><code>new_group</code></em> :</span></p></td>
427
<div class="refsect1" lang="en">
428
<a name="id388806"></a><h2>Signal Details</h2>
429
<div class="refsect2" lang="en">
430
<a name="id388816"></a><h3>
431
<a name="EmpathyContactList-groups-changed"></a>The <code class="literal">"groups-changed"</code> signal</h3>
432
<a class="indexterm" name="id388828"></a><pre class="programlisting">void user_function (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *empathycontactlist,
433
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *arg1,
436
gpointer user_data) : Run Last</pre>
440
<div class="variablelist"><table border="0">
441
<col align="left" valign="top">
444
<td><p><span class="term"><em class="parameter"><code>empathycontactlist</code></em> :</span></p></td>
445
<td>the object which received the signal.
449
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
454
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
459
<td><p><span class="term"><em class="parameter"><code>arg3</code></em> :</span></p></td>
465
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
466
<td>user data set when the signal handler was connected.</td>
472
<div class="refsect2" lang="en">
473
<a name="id388941"></a><h3>
474
<a name="EmpathyContactList-members-changed"></a>The <code class="literal">"members-changed"</code> signal</h3>
475
<a class="indexterm" name="id388954"></a><pre class="programlisting">void user_function (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *empathycontactlist,
476
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *arg1,
477
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *arg2,
481
gpointer user_data) : Run Last</pre>
485
<div class="variablelist"><table border="0">
486
<col align="left" valign="top">
489
<td><p><span class="term"><em class="parameter"><code>empathycontactlist</code></em> :</span></p></td>
490
<td>the object which received the signal.
494
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
499
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
504
<td><p><span class="term"><em class="parameter"><code>arg3</code></em> :</span></p></td>
509
<td><p><span class="term"><em class="parameter"><code>arg4</code></em> :</span></p></td>
514
<td><p><span class="term"><em class="parameter"><code>arg5</code></em> :</span></p></td>
520
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
521
<td>user data set when the signal handler was connected.</td>
527
<div class="refsect2" lang="en">
528
<a name="id389104"></a><h3>
529
<a name="EmpathyContactList-pendings-changed"></a>The <code class="literal">"pendings-changed"</code> signal</h3>
530
<a class="indexterm" name="id389117"></a><pre class="programlisting">void user_function (<a class="link" href="libempathy-empathy-contact-list.html#EmpathyContactList">EmpathyContactList</a> *empathycontactlist,
531
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *arg1,
532
<a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *arg2,
536
gpointer user_data) : Run Last</pre>
540
<div class="variablelist"><table border="0">
541
<col align="left" valign="top">
544
<td><p><span class="term"><em class="parameter"><code>empathycontactlist</code></em> :</span></p></td>
545
<td>the object which received the signal.
549
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
554
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
559
<td><p><span class="term"><em class="parameter"><code>arg3</code></em> :</span></p></td>
564
<td><p><span class="term"><em class="parameter"><code>arg4</code></em> :</span></p></td>
569
<td><p><span class="term"><em class="parameter"><code>arg5</code></em> :</span></p></td>
575
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
576
<td>user data set when the signal handler was connected.</td>
582
<div class="refsect1" lang="en">
583
<a name="id389269"></a><div class="refsect2" lang="en"><a name="id389270"></a></div>
585
<div class="refsect2" lang="en"><a name="id389271"></a></div>