annotate src/blist.h @ 12810:b0ede7907dd0

[gaim-migrate @ 15158] Improve the handling of SRV results. If we get a result, use the specified port; if you want to manually specify the port, you need to manually specify the connect server and not do the SRV lookup at all. This was discussed in #gaim last night. committer: Tailor Script <tailor@pidgin.im>
author Daniel Atallah <daniel.atallah@gmail.com>
date Tue, 10 Jan 2006 20:39:47 +0000
parents e63a80be5227
children 248b8b39c671
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 /**
5497
3c7748b24410 [gaim-migrate @ 5893]
Mark Doliner <mark@kingant.net>
parents: 5277
diff changeset
2 * @file blist.h Buddy List API
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 * @ingroup core
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
4 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
5 * gaim
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
6 *
8046
fa6395637e2c [gaim-migrate @ 8730]
Sean Egan <seanegan@gmail.com>
parents: 8012
diff changeset
7 * Gaim is the legal property of its developers, whose names are too numerous
fa6395637e2c [gaim-migrate @ 8730]
Sean Egan <seanegan@gmail.com>
parents: 8012
diff changeset
8 * to list here. Please refer to the COPYRIGHT file distributed with this
fa6395637e2c [gaim-migrate @ 8730]
Sean Egan <seanegan@gmail.com>
parents: 8012
diff changeset
9 * source distribution.
6485
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
10 *
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
11 * This program is free software; you can redistribute it and/or modify
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 * it under the terms of the GNU General Public License as published by
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13 * the Free Software Foundation; either version 2 of the License, or
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 * (at your option) any later version.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 * This program is distributed in the hope that it will be useful,
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 * GNU General Public License for more details.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 * You should have received a copy of the GNU General Public License
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 * along with this program; if not, write to the Free Software
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 */
9713
db62420a53a2 [gaim-migrate @ 10574]
Mark Doliner <mark@kingant.net>
parents: 9635
diff changeset
25 #ifndef _GAIM_BLIST_H_
db62420a53a2 [gaim-migrate @ 10574]
Mark Doliner <mark@kingant.net>
parents: 9635
diff changeset
26 #define _GAIM_BLIST_H_
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 #include <glib.h>
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31
7098
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
32 typedef struct _GaimBuddyList GaimBuddyList;
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
33 typedef struct _GaimBlistUiOps GaimBlistUiOps;
5564
187c740f2a4e [gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents: 5563
diff changeset
34 typedef struct _GaimBlistNode GaimBlistNode;
187c740f2a4e [gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents: 5563
diff changeset
35
9030
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
36 typedef struct _GaimBlistNodeAction GaimBlistNodeAction;
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
37
7118
bf630f7dfdcd [gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents: 7117
diff changeset
38 typedef struct _GaimChat GaimChat;
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
39 typedef struct _GaimGroup GaimGroup;
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
40 typedef struct _GaimContact GaimContact;
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
41 typedef struct _GaimBuddy GaimBuddy;
5564
187c740f2a4e [gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents: 5563
diff changeset
42
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
43 /**************************************************************************/
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
44 /* Enumerations */
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45 /**************************************************************************/
7098
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
46 typedef enum
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
47 {
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
48 GAIM_BLIST_GROUP_NODE,
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
49 GAIM_BLIST_CONTACT_NODE,
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
50 GAIM_BLIST_BUDDY_NODE,
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
51 GAIM_BLIST_CHAT_NODE,
6063
5239a3b4ab33 [gaim-migrate @ 6513]
Nathan Walp <nwalp@pidgin.im>
parents: 6059
diff changeset
52 GAIM_BLIST_OTHER_NODE
7098
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
53
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
54 } GaimBlistNodeType;
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
55
9944
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
56 #define GAIM_BLIST_NODE_IS_CHAT(n) ((n)->type == GAIM_BLIST_CHAT_NODE)
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
57 #define GAIM_BLIST_NODE_IS_BUDDY(n) ((n)->type == GAIM_BLIST_BUDDY_NODE)
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
58 #define GAIM_BLIST_NODE_IS_CONTACT(n) ((n)->type == GAIM_BLIST_CONTACT_NODE)
9944
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
59 #define GAIM_BLIST_NODE_IS_GROUP(n) ((n)->type == GAIM_BLIST_GROUP_NODE)
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60
9944
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
61 #define GAIM_BUDDY_IS_ONLINE(b) \
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
62 ((b) != NULL && gaim_account_is_connected((b)->account) && \
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
63 gaim_presence_is_online(gaim_buddy_get_presence(b)))
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64
9787
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
65 typedef enum
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
66 {
10008
50c1724d5e59 [gaim-migrate @ 10925]
Mark Doliner <mark@kingant.net>
parents: 9997
diff changeset
67 GAIM_BLIST_NODE_FLAG_NO_SAVE = 1 /**< node should not be saved with the buddy list */
50c1724d5e59 [gaim-migrate @ 10925]
Mark Doliner <mark@kingant.net>
parents: 9997
diff changeset
68
9787
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
69 } GaimBlistNodeFlags;
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
70
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
71 #define GAIM_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f))
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
72 #define GAIM_BLIST_NODE_SHOULD_SAVE(b) (! GAIM_BLIST_NODE_HAS_FLAG(b, GAIM_BLIST_NODE_FLAG_NO_SAVE))
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
73
12519
e63a80be5227 [gaim-migrate @ 14831]
Sean Egan <seanegan@gmail.com>
parents: 12323
diff changeset
74 #define GAIM_BLIST_NODE_NAME(n) ((n)->type == GAIM_BLIST_CHAT_NODE ? gaim_chat_get_name((GaimChat*)n) : \
e63a80be5227 [gaim-migrate @ 14831]
Sean Egan <seanegan@gmail.com>
parents: 12323
diff changeset
75 (n)->type == GAIM_BLIST_BUDDY_NODE ? gaim_buddy_get_name((GaimBuddy*)n) : NULL)
e63a80be5227 [gaim-migrate @ 14831]
Sean Egan <seanegan@gmail.com>
parents: 12323
diff changeset
76
10008
50c1724d5e59 [gaim-migrate @ 10925]
Mark Doliner <mark@kingant.net>
parents: 9997
diff changeset
77 #include "account.h"
50c1724d5e59 [gaim-migrate @ 10925]
Mark Doliner <mark@kingant.net>
parents: 9997
diff changeset
78 #include "buddyicon.h"
50c1724d5e59 [gaim-migrate @ 10925]
Mark Doliner <mark@kingant.net>
parents: 9997
diff changeset
79 #include "status.h"
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
80
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
81 /**************************************************************************/
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
82 /* Data Structures */
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
83 /**************************************************************************/
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
84
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
85 /**
10566
62fc579810f4 [gaim-migrate @ 11949]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10548
diff changeset
86 * A Buddy list node. This can represent a group, a buddy, or anything else.
62fc579810f4 [gaim-migrate @ 11949]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10548
diff changeset
87 * This is a base class for struct buddy and struct group and for anything
62fc579810f4 [gaim-migrate @ 11949]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10548
diff changeset
88 * else that wants to put itself in the buddy list. */
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
89 struct _GaimBlistNode {
7098
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
90 GaimBlistNodeType type; /**< The type of node this is */
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
91 GaimBlistNode *prev; /**< The sibling before this buddy. */
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
92 GaimBlistNode *next; /**< The sibling after this buddy. */
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
93 GaimBlistNode *parent; /**< The parent of this node */
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
94 GaimBlistNode *child; /**< The child of this node */
7693
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
95 GHashTable *settings; /**< per-node settings */
7098
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
96 void *ui_data; /**< The UI can put data here. */
9787
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
97 GaimBlistNodeFlags flags; /**< The buddy flags */
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
98 };
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
99
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
100 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
101 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
102 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
103 struct _GaimBuddy {
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
104 GaimBlistNode node; /**< The node that this buddy inherits from */
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
105 char *name; /**< The screenname of the buddy. */
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
106 char *alias; /**< The user-set alias of the buddy */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
107 char *server_alias; /**< The server-specified alias of the buddy. (i.e. MSN "Friendly Names") */
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
108 void *proto_data; /**< This allows the prpl to associate whatever data it wants with a buddy */
6846
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
109 GaimBuddyIcon *icon; /**< The buddy icon. */
11972
73777ad45562 [gaim-migrate @ 14265]
Mark Doliner <mark@kingant.net>
parents: 11910
diff changeset
110 GaimAccount *account; /**< the account this buddy belongs to */
9949
ced29c7b396c [gaim-migrate @ 10845]
Luke Schierer <lschiere@pidgin.im>
parents: 9944
diff changeset
111 GaimPresence *presence;
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
112 };
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
113
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
114 /**
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
115 * A contact. This contains everything Gaim will ever need to know about a contact.
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
116 */
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
117 struct _GaimContact {
6755
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
118 GaimBlistNode node; /**< The node that this contact inherits from. */
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
119 char *alias; /**< The user-set alias of the contact */
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
120 int totalsize; /**< The number of buddies in this contact */
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
121 int currentsize; /**< The number of buddies in this contact corresponding to online accounts */
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
122 int online; /**< The number of buddies in this contact who are currently online */
6843
549a0bbbf73d [gaim-migrate @ 7388]
Nathan Walp <nwalp@pidgin.im>
parents: 6755
diff changeset
123 GaimBuddy *priority; /**< The "top" buddy for this contact */
10378
28135f8c226d [gaim-migrate @ 11603]
Tim Ringenbach <marv@pidgin.im>
parents: 10350
diff changeset
124 gboolean priority_valid; /**< Is priority valid? */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
125 };
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
126
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
127
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
128 /**
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
129 * A group. This contains everything Gaim will ever need to know about a group.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
130 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
131 struct _GaimGroup {
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
132 GaimBlistNode node; /**< The node that this group inherits from */
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
133 char *name; /**< The name of this group. */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
134 int totalsize; /**< The number of chats and contacts in this group */
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
135 int currentsize; /**< The number of chats and contacts in this group corresponding to online accounts */
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
136 int online; /**< The number of chats and contacts in this group who are currently online */
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
137 };
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
138
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
139 /**
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
140 * A chat. This contains everything Gaim needs to put a chat room in the
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
141 * buddy list.
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
142 */
7118
bf630f7dfdcd [gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents: 7117
diff changeset
143 struct _GaimChat {
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
144 GaimBlistNode node; /**< The node that this chat inherits from */
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
145 char *alias; /**< The display name of this chat. */
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
146 GHashTable *components; /**< the stuff the protocol needs to know to join the chat */
5563
9eb5b13fd412 [gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents: 5497
diff changeset
147 GaimAccount *account; /**< The account this chat is attached to */
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
148 };
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
149
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
150
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
151 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
152 * The Buddy List
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
153 */
7098
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
154 struct _GaimBuddyList {
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
155 GaimBlistNode *root; /**< The first node in the buddy list */
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
156 GHashTable *buddies; /**< Every buddy in this list */
12054
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
157 GaimBlistUiOps *ui_ops; /**< The UI operations for the buddy list */
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
158
7098
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
159 void *ui_data; /**< UI-specific data. */
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
160 };
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
161
12054
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
162 /**
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
163 * Buddy list UI operations.
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
164 *
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
165 * Any UI representing a buddy list must assign a filled-out GaimBlistUiOps
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
166 * structure to the buddy list core.
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
167 */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
168 struct _GaimBlistUiOps
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
169 {
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
170 void (*new_list)(GaimBuddyList *list); /**< Sets UI-specific data on a buddy list. */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
171 void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
172 void (*show)(GaimBuddyList *list); /**< The core will call this when it's finished doing its core stuff */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
173 void (*update)(GaimBuddyList *list,
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
174 GaimBlistNode *node); /**< This will update a node in the buddy list. */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
175 void (*remove)(GaimBuddyList *list,
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
176 GaimBlistNode *node); /**< This removes a node from the list */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
177 void (*destroy)(GaimBuddyList *list); /**< When the list gets destroyed, this gets called to destroy the UI. */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
178 void (*set_visible)(GaimBuddyList *list,
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
179 gboolean show); /**< Hides or unhides the buddy list */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
180 void (*request_add_buddy)(GaimAccount *account, const char *username,
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
181 const char *group, const char *alias);
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
182 void (*request_add_chat)(GaimAccount *account, GaimGroup *group,
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
183 const char *alias, const char *name);
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
184 void (*request_add_group)(void);
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
185 };
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
186
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
187
9030
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
188 struct _GaimBlistNodeAction {
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
189 char *label;
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
190 void (*callback)(GaimBlistNode *, gpointer);
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
191 gpointer data;
10662
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
192 GList *children;
9030
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
193 };
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
194
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
195
5944
158196b2db19 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5906
diff changeset
196 #ifdef __cplusplus
158196b2db19 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5906
diff changeset
197 extern "C" {
158196b2db19 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5906
diff changeset
198 #endif
158196b2db19 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5906
diff changeset
199
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
200 /**************************************************************************/
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
201 /** @name Buddy List API */
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
202 /**************************************************************************/
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
203 /*@{*/
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
204
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
205 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
206 * Creates a new buddy list
10071
af06746954de [gaim-migrate @ 11047]
Mark Doliner <mark@kingant.net>
parents: 10052
diff changeset
207 *
af06746954de [gaim-migrate @ 11047]
Mark Doliner <mark@kingant.net>
parents: 10052
diff changeset
208 * @return The new buddy list.
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
209 */
12323
fc464a0abccc [gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents: 12319
diff changeset
210 GaimBuddyList *gaim_blist_new(void);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
211
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
212 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
213 * Sets the main buddy list.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
214 *
10071
af06746954de [gaim-migrate @ 11047]
Mark Doliner <mark@kingant.net>
parents: 10052
diff changeset
215 * @param blist The buddy list you want to use.
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
216 */
7098
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
217 void gaim_set_blist(GaimBuddyList *blist);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
218
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
219 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
220 * Returns the main buddy list.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
221 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
222 * @return The main buddy list.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
223 */
7098
770233dad86c [gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents: 7060
diff changeset
224 GaimBuddyList *gaim_get_blist(void);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
225
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
226 /**
12112
875f59f9c0bb [gaim-migrate @ 14412]
Sean Egan <seanegan@gmail.com>
parents: 12088
diff changeset
227 * Returns the next node of a given node. This function is to be used to iterate
875f59f9c0bb [gaim-migrate @ 14412]
Sean Egan <seanegan@gmail.com>
parents: 12088
diff changeset
228 * over the tree returned by gaim_get_blist.
875f59f9c0bb [gaim-migrate @ 14412]
Sean Egan <seanegan@gmail.com>
parents: 12088
diff changeset
229 *
875f59f9c0bb [gaim-migrate @ 14412]
Sean Egan <seanegan@gmail.com>
parents: 12088
diff changeset
230 * @param node A node.
875f59f9c0bb [gaim-migrate @ 14412]
Sean Egan <seanegan@gmail.com>
parents: 12088
diff changeset
231 * @param offline Whether to include nodes for offline accounts
875f59f9c0bb [gaim-migrate @ 14412]
Sean Egan <seanegan@gmail.com>
parents: 12088
diff changeset
232 * @return The next node
875f59f9c0bb [gaim-migrate @ 14412]
Sean Egan <seanegan@gmail.com>
parents: 12088
diff changeset
233 */
875f59f9c0bb [gaim-migrate @ 14412]
Sean Egan <seanegan@gmail.com>
parents: 12088
diff changeset
234 GaimBlistNode *gaim_blist_node_next(GaimBlistNode *node, gboolean offline);
875f59f9c0bb [gaim-migrate @ 14412]
Sean Egan <seanegan@gmail.com>
parents: 12088
diff changeset
235
875f59f9c0bb [gaim-migrate @ 14412]
Sean Egan <seanegan@gmail.com>
parents: 12088
diff changeset
236 /**
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
237 * Shows the buddy list, creating a new one if necessary.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
238 */
12323
fc464a0abccc [gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents: 12319
diff changeset
239 void gaim_blist_show(void);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
240
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
241
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
242 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
243 * Destroys the buddy list window.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
244 */
12323
fc464a0abccc [gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents: 12319
diff changeset
245 void gaim_blist_destroy(void);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
246
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
247 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
248 * Hides or unhides the buddy list.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
249 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
250 * @param show Whether or not to show the buddy list
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
251 */
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
252 void gaim_blist_set_visible(gboolean show);
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
253
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
254 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
255 * Updates a buddy's status.
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
256 *
10052
eaec201b2688 [gaim-migrate @ 11013]
Mark Doliner <mark@kingant.net>
parents: 10037
diff changeset
257 * @param buddy The buddy whose status has changed.
eaec201b2688 [gaim-migrate @ 11013]
Mark Doliner <mark@kingant.net>
parents: 10037
diff changeset
258 * @param old_status The status from which we are changing.
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
259 */
10052
eaec201b2688 [gaim-migrate @ 11013]
Mark Doliner <mark@kingant.net>
parents: 10037
diff changeset
260 void gaim_blist_update_buddy_status(GaimBuddy *buddy, GaimStatus *old_status);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
261
7950
7b8407d8c546 [gaim-migrate @ 8624]
Mark Doliner <mark@kingant.net>
parents: 7859
diff changeset
262 /**
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
263 * Updates a buddy's icon.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
264 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
265 * @param buddy The buddy whose buddy icon has changed
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
266 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
267 void gaim_blist_update_buddy_icon(GaimBuddy *buddy);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
268
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
269 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
270 * Renames a buddy in the buddy list.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
271 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
272 * @param buddy The buddy whose name will be changed.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
273 * @param name The new name of the buddy.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
274 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
275 void gaim_blist_rename_buddy(GaimBuddy *buddy, const char *name);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
276
12319
7630a95f3b8b [gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents: 12286
diff changeset
277 /**
7630a95f3b8b [gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents: 12286
diff changeset
278 * Aliases a contact in the buddy list.
7630a95f3b8b [gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents: 12286
diff changeset
279 *
7630a95f3b8b [gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents: 12286
diff changeset
280 * @param contact The contact whose alias will be changed.
7630a95f3b8b [gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents: 12286
diff changeset
281 * @param alias The contact's alias.
7630a95f3b8b [gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents: 12286
diff changeset
282 */
7630a95f3b8b [gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents: 12286
diff changeset
283 void gaim_blist_alias_contact(GaimContact *contact, const char *alias);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
284
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
285 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
286 * Aliases a buddy in the buddy list.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
287 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
288 * @param buddy The buddy whose alias will be changed.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
289 * @param alias The buddy's alias.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
290 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
291 void gaim_blist_alias_buddy(GaimBuddy *buddy, const char *alias);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
292
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
293 /**
6059
d8cd876e613e [gaim-migrate @ 6509]
Mark Doliner <mark@kingant.net>
parents: 6058
diff changeset
294 * Sets the server-sent alias of a buddy in the buddy list.
6058
d5f4ae4f9a02 [gaim-migrate @ 6508]
Mark Doliner <mark@kingant.net>
parents: 6036
diff changeset
295 *
d5f4ae4f9a02 [gaim-migrate @ 6508]
Mark Doliner <mark@kingant.net>
parents: 6036
diff changeset
296 * @param buddy The buddy whose alias will be changed.
d5f4ae4f9a02 [gaim-migrate @ 6508]
Mark Doliner <mark@kingant.net>
parents: 6036
diff changeset
297 * @param alias The buddy's "official" alias.
d5f4ae4f9a02 [gaim-migrate @ 6508]
Mark Doliner <mark@kingant.net>
parents: 6036
diff changeset
298 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
299 void gaim_blist_server_alias_buddy(GaimBuddy *buddy, const char *alias);
6058
d5f4ae4f9a02 [gaim-migrate @ 6508]
Mark Doliner <mark@kingant.net>
parents: 6036
diff changeset
300
d5f4ae4f9a02 [gaim-migrate @ 6508]
Mark Doliner <mark@kingant.net>
parents: 6036
diff changeset
301 /**
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
302 * Aliases a chat in the buddy list.
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
303 *
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
304 * @param chat The chat whose alias will be changed.
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
305 * @param alias The chat's new alias.
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
306 */
7118
bf630f7dfdcd [gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents: 7117
diff changeset
307 void gaim_blist_alias_chat(GaimChat *chat, const char *alias);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
308
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
309 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
310 * Renames a group
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
311 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
312 * @param group The group to rename
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
313 * @param name The new name
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
314 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
315 void gaim_blist_rename_group(GaimGroup *group, const char *name);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
316
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
317 /**
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
318 * Creates a new chat for the buddy list
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
319 *
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
320 * @param account The account this chat will get added to
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
321 * @param alias The alias of the new chat
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
322 * @param components The info the prpl needs to join the chat
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
323 * @return A newly allocated chat
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
324 */
7125
208cb260d7a7 [gaim-migrate @ 7692]
Nathan Walp <nwalp@pidgin.im>
parents: 7118
diff changeset
325 GaimChat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components);
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
326
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
327 /**
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
328 * Adds a new chat to the buddy list.
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
329 *
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
330 * The chat will be inserted right after node or appended to the end
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
331 * of group if node is NULL. If both are NULL, the buddy will be added to
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
332 * the "Chats" group.
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
333 *
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
334 * @param chat The new chat who gets added
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
335 * @param group The group to add the new chat to.
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
336 * @param node The insertion point
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
337 */
7118
bf630f7dfdcd [gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents: 7117
diff changeset
338 void gaim_blist_add_chat(GaimChat *chat, GaimGroup *group, GaimBlistNode *node);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
339
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
340 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
341 * Creates a new buddy
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
342 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
343 * @param account The account this buddy will get added to
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
344 * @param screenname The screenname of the new buddy
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
345 * @param alias The alias of the new buddy (or NULL if unaliased)
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
346 * @return A newly allocated buddy
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
347 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
348 GaimBuddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
349
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
350 /**
6846
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
351 * Sets a buddy's icon.
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
352 *
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
353 * This should only be called from within Gaim. You probably want to
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
354 * call gaim_buddy_icon_set_data().
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
355 *
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
356 * @param buddy The buddy.
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
357 * @param icon The buddy icon.
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
358 *
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
359 * @see gaim_buddy_icon_set_data()
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
360 */
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
361 void gaim_buddy_set_icon(GaimBuddy *buddy, GaimBuddyIcon *icon);
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
362
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
363 /**
10037
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
364 * Returns a buddy's account.
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
365 *
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
366 * @param buddy The buddy.
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
367 *
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
368 * @return The account
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
369 */
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
370 GaimAccount *gaim_buddy_get_account(const GaimBuddy *buddy);
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
371
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
372 /**
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
373 * Returns a buddy's name
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
374 *
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
375 * @param buddy The buddy.
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
376 *
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
377 * @return The name.
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
378 */
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
379 const char *gaim_buddy_get_name(const GaimBuddy *buddy);
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
380
e6e68b9db19b [gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents: 10012
diff changeset
381 /**
6846
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
382 * Returns a buddy's icon.
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
383 *
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
384 * @param buddy The buddy.
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
385 *
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
386 * @return The buddy icon.
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
387 */
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
388 GaimBuddyIcon *gaim_buddy_get_icon(const GaimBuddy *buddy);
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
389
8ab95f4c9800 [gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents: 6843
diff changeset
390 /**
7312
b8ce6e194cff [gaim-migrate @ 7896]
Nathan Walp <nwalp@pidgin.im>
parents: 7246
diff changeset
391 * Returns a buddy's contact.
b8ce6e194cff [gaim-migrate @ 7896]
Nathan Walp <nwalp@pidgin.im>
parents: 7246
diff changeset
392 *
b8ce6e194cff [gaim-migrate @ 7896]
Nathan Walp <nwalp@pidgin.im>
parents: 7246
diff changeset
393 * @param buddy The buddy.
b8ce6e194cff [gaim-migrate @ 7896]
Nathan Walp <nwalp@pidgin.im>
parents: 7246
diff changeset
394 *
b8ce6e194cff [gaim-migrate @ 7896]
Nathan Walp <nwalp@pidgin.im>
parents: 7246
diff changeset
395 * @return The buddy's contact.
b8ce6e194cff [gaim-migrate @ 7896]
Nathan Walp <nwalp@pidgin.im>
parents: 7246
diff changeset
396 */
b8ce6e194cff [gaim-migrate @ 7896]
Nathan Walp <nwalp@pidgin.im>
parents: 7246
diff changeset
397 GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy);
b8ce6e194cff [gaim-migrate @ 7896]
Nathan Walp <nwalp@pidgin.im>
parents: 7246
diff changeset
398
b8ce6e194cff [gaim-migrate @ 7896]
Nathan Walp <nwalp@pidgin.im>
parents: 7246
diff changeset
399 /**
9944
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
400 * Returns a buddy's presence.
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
401 *
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
402 * @param buddy The buddy.
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
403 *
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
404 * @return The buddy's presence.
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
405 */
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
406 GaimPresence *gaim_buddy_get_presence(const GaimBuddy *buddy);
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
407
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
408 /**
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
409 * Adds a new buddy to the buddy list.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
410 *
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
411 * The buddy will be inserted right after node or prepended to the
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
412 * group if node is NULL. If both are NULL, the buddy will be added to
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
413 * the "Buddies" group.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
414 *
6720
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
415 * @param buddy The new buddy who gets added
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
416 * @param contact The optional contact to place the buddy in.
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
417 * @param group The group to add the new buddy to.
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
418 * @param node The insertion point
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
419 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
420 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
421
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
422 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
423 * Creates a new group
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
424 *
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
425 * You can't have more than one group with the same name. Sorry. If you pass
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
426 * this the * name of a group that already exists, it will return that group.
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
427 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
428 * @param name The name of the new group
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
429 * @return A new group struct
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
430 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
431 GaimGroup *gaim_group_new(const char *name);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
432
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
433 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
434 * Adds a new group to the buddy list.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
435 *
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
436 * The new group will be inserted after insert or prepended to the list if
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
437 * node is NULL.
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
438 *
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
439 * @param group The group
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
440 * @param node The insertion point
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
441 */
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
442 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node);
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
443
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
444 /**
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
445 * Creates a new contact
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
446 *
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
447 * @return A new contact struct
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
448 */
12323
fc464a0abccc [gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents: 12319
diff changeset
449 GaimContact *gaim_contact_new(void);
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
450
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
451 /**
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
452 * Adds a new contact to the buddy list.
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
453 *
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
454 * The new contact will be inserted after insert or prepended to the list if
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
455 * node is NULL.
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
456 *
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
457 * @param contact The contact
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
458 * @param group The group to add the contact to
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
459 * @param node The insertion point
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
460 */
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
461 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node);
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
462
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
463 /**
6965
d4b4229bcd21 [gaim-migrate @ 7512]
Nathan Walp <nwalp@pidgin.im>
parents: 6872
diff changeset
464 * Merges two contacts
d4b4229bcd21 [gaim-migrate @ 7512]
Nathan Walp <nwalp@pidgin.im>
parents: 6872
diff changeset
465 *
d4b4229bcd21 [gaim-migrate @ 7512]
Nathan Walp <nwalp@pidgin.im>
parents: 6872
diff changeset
466 * All of the buddies from source will be moved to target
d4b4229bcd21 [gaim-migrate @ 7512]
Nathan Walp <nwalp@pidgin.im>
parents: 6872
diff changeset
467 *
d4b4229bcd21 [gaim-migrate @ 7512]
Nathan Walp <nwalp@pidgin.im>
parents: 6872
diff changeset
468 * @param source The contact to merge
7246
cb6bf374c7ee [gaim-migrate @ 7823]
Nathan Walp <nwalp@pidgin.im>
parents: 7125
diff changeset
469 * @param node The place to merge to (a buddy or contact)
6965
d4b4229bcd21 [gaim-migrate @ 7512]
Nathan Walp <nwalp@pidgin.im>
parents: 6872
diff changeset
470 */
7246
cb6bf374c7ee [gaim-migrate @ 7823]
Nathan Walp <nwalp@pidgin.im>
parents: 7125
diff changeset
471 void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node);
6965
d4b4229bcd21 [gaim-migrate @ 7512]
Nathan Walp <nwalp@pidgin.im>
parents: 6872
diff changeset
472
d4b4229bcd21 [gaim-migrate @ 7512]
Nathan Walp <nwalp@pidgin.im>
parents: 6872
diff changeset
473 /**
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
474 * Returns the highest priority buddy for a given contact.
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
475 *
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
476 * @param contact The contact
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
477 * @return The highest priority buddy
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
478 */
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
479 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
480
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
481 /**
6755
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
482 * Sets the alias for a contact.
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
483 *
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
484 * @param contact The contact
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
485 * @param alias The alias to set, or NULL to unset
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
486 */
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
487 void gaim_contact_set_alias(GaimContact *contact, const char *alias);
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
488
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
489 /**
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
490 * Gets the alias for a contact.
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
491 *
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
492 * @param contact The contact
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
493 * @return The alias, or NULL if it is not set.
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
494 */
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
495 const char *gaim_contact_get_alias(GaimContact *contact);
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
496
ea289c6f2382 [gaim-migrate @ 7287]
Nathan Walp <nwalp@pidgin.im>
parents: 6744
diff changeset
497 /**
9787
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
498 * Determines whether an account owns any buddies in a given contact
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
499 *
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
500 * @param contact The contact to search through.
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
501 * @param account The account.
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
502 *
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
503 * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise.
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
504 */
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
505 gboolean gaim_contact_on_account(GaimContact *contact, GaimAccount *account);
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
506
904b757835ca [gaim-migrate @ 10655]
Luke Schierer <lschiere@pidgin.im>
parents: 9754
diff changeset
507 /**
10378
28135f8c226d [gaim-migrate @ 11603]
Tim Ringenbach <marv@pidgin.im>
parents: 10350
diff changeset
508 * Invalidates the priority buddy so that the next call to
28135f8c226d [gaim-migrate @ 11603]
Tim Ringenbach <marv@pidgin.im>
parents: 10350
diff changeset
509 * gaim_contact_get_priority_buddy recomputes it.
9944
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
510 *
10378
28135f8c226d [gaim-migrate @ 11603]
Tim Ringenbach <marv@pidgin.im>
parents: 10350
diff changeset
511 * @param contact The contact
9944
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
512 */
10378
28135f8c226d [gaim-migrate @ 11603]
Tim Ringenbach <marv@pidgin.im>
parents: 10350
diff changeset
513 void gaim_contact_invalidate_priority_buddy(GaimContact *contact);
9944
e4a27c9aec4c [gaim-migrate @ 10838]
Luke Schierer <lschiere@pidgin.im>
parents: 9939
diff changeset
514 /**
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
515 * Removes a buddy from the buddy list and frees the memory allocated to it.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
516 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
517 * @param buddy The buddy to be removed
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
518 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
519 void gaim_blist_remove_buddy(GaimBuddy *buddy);
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
520
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
521 /**
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
522 * Removes a contact, and any buddies it contains, and frees the memory
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
523 * allocated to it.
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
524 *
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
525 * @param contact The contact to be removed
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
526 */
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
527 void gaim_blist_remove_contact(GaimContact *contact);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
528
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
529 /**
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
530 * Removes a chat from the buddy list and frees the memory allocated to it.
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
531 *
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
532 * @param chat The chat to be removed
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
533 */
7118
bf630f7dfdcd [gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents: 7117
diff changeset
534 void gaim_blist_remove_chat(GaimChat *chat);
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
535
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
536 /**
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
537 * Removes a group from the buddy list and frees the memory allocated to it and to
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
538 * its children
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
539 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
540 * @param group The group to be removed
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
541 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
542 void gaim_blist_remove_group(GaimGroup *group);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
543
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
544 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
545 * Returns the alias of a buddy.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
546 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
547 * @param buddy The buddy whose name will be returned.
10349
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
548 * @return The alias (if set), server alias (if set),
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
549 * or NULL.
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
550 */
9620
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
551 const char *gaim_buddy_get_alias_only(GaimBuddy *buddy);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
552
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
553
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
554 /**
9620
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
555 * Returns the correct name to display for a buddy, taking the contact alias
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
556 * into account. In order of precedence: the buddy's alias; the buddy's
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
557 * contact alias; the buddy's server alias; the buddy's user name.
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
558 *
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
559 * @param buddy The buddy whose name will be returned
9635
8ad07c6f6522 [gaim-migrate @ 10479]
Mark Doliner <mark@kingant.net>
parents: 9620
diff changeset
560 * @return The appropriate name or alias, or NULL.
9620
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
561 *
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
562 */
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
563 const char *gaim_buddy_get_contact_alias(GaimBuddy *buddy);
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
564
10349
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
565 /**
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
566 * Returns the correct alias for this user, ignoring server aliases. Used
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
567 * when a user-recognizable name is required. In order: buddy's alias; buddy's
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
568 * contact alias; buddy's user name.
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
569 *
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
570 * @param buddy The buddy whose alias will be returned.
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
571 * @return The appropriate name or alias.
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
572 */
655c48791b3c [gaim-migrate @ 11563]
Sean Egan <seanegan@gmail.com>
parents: 10348
diff changeset
573 const char *gaim_buddy_get_local_alias(GaimBuddy *buddy);
9620
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
574
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
575 /**
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
576 * Returns the correct name to display for a buddy. In order of precedence:
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
577 * the buddy's alias; the buddy's server alias; the buddy's contact alias;
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
578 * the buddy's user name.
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
579 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
580 * @param buddy The buddy whose name will be returned.
9635
8ad07c6f6522 [gaim-migrate @ 10479]
Mark Doliner <mark@kingant.net>
parents: 9620
diff changeset
581 * @return The appropriate name or alias, or NULL
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
582 */
9620
c001be3c330e [gaim-migrate @ 10464]
Mark Doliner <mark@kingant.net>
parents: 9460
diff changeset
583 const char *gaim_buddy_get_alias(GaimBuddy *buddy);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
584
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
585 /**
6744
a781689ca455 [gaim-migrate @ 7276]
Nathan Walp <nwalp@pidgin.im>
parents: 6735
diff changeset
586 * Returns the correct name to display for a blist chat.
a781689ca455 [gaim-migrate @ 7276]
Nathan Walp <nwalp@pidgin.im>
parents: 6735
diff changeset
587 *
a781689ca455 [gaim-migrate @ 7276]
Nathan Walp <nwalp@pidgin.im>
parents: 6735
diff changeset
588 * @param chat The chat whose name will be returned.
a781689ca455 [gaim-migrate @ 7276]
Nathan Walp <nwalp@pidgin.im>
parents: 6735
diff changeset
589 * @return The alias (if set), or first component value.
a781689ca455 [gaim-migrate @ 7276]
Nathan Walp <nwalp@pidgin.im>
parents: 6735
diff changeset
590 */
7125
208cb260d7a7 [gaim-migrate @ 7692]
Nathan Walp <nwalp@pidgin.im>
parents: 7118
diff changeset
591 const char *gaim_chat_get_name(GaimChat *chat);
6744
a781689ca455 [gaim-migrate @ 7276]
Nathan Walp <nwalp@pidgin.im>
parents: 6735
diff changeset
592
a781689ca455 [gaim-migrate @ 7276]
Nathan Walp <nwalp@pidgin.im>
parents: 6735
diff changeset
593 /**
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
594 * Finds the buddy struct given a screenname and an account
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
595 *
10071
af06746954de [gaim-migrate @ 11047]
Mark Doliner <mark@kingant.net>
parents: 10052
diff changeset
596 * @param account The account this buddy belongs to
6872
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
597 * @param name The buddy's screenname
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
598 * @return The buddy or NULL if the buddy does not exist
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
599 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
600 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name);
6245
9083f92e0d58 [gaim-migrate @ 6739]
Nathan Walp <nwalp@pidgin.im>
parents: 6063
diff changeset
601
9083f92e0d58 [gaim-migrate @ 6739]
Nathan Walp <nwalp@pidgin.im>
parents: 6063
diff changeset
602 /**
6872
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
603 * Finds the buddy struct given a screenname, an account, and a group
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
604 *
10071
af06746954de [gaim-migrate @ 11047]
Mark Doliner <mark@kingant.net>
parents: 10052
diff changeset
605 * @param account The account this buddy belongs to
6872
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
606 * @param name The buddy's screenname
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
607 * @param group The group to look in
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
608 * @return The buddy or NULL if the buddy does not exist in the group
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
609 */
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
610 GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name,
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
611 GaimGroup *group);
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
612
dd0eecfbe413 [gaim-migrate @ 7418]
Nathan Walp <nwalp@pidgin.im>
parents: 6846
diff changeset
613 /**
9285
7a8aa87164ae [gaim-migrate @ 10088]
Mark Doliner <mark@kingant.net>
parents: 9030
diff changeset
614 * Finds all GaimBuddy structs given a screenname and an account
6245
9083f92e0d58 [gaim-migrate @ 6739]
Nathan Walp <nwalp@pidgin.im>
parents: 6063
diff changeset
615 *
10071
af06746954de [gaim-migrate @ 11047]
Mark Doliner <mark@kingant.net>
parents: 10052
diff changeset
616 * @param account The account this buddy belongs to
6245
9083f92e0d58 [gaim-migrate @ 6739]
Nathan Walp <nwalp@pidgin.im>
parents: 6063
diff changeset
617 * @param name The buddy's screenname
9083f92e0d58 [gaim-migrate @ 6739]
Nathan Walp <nwalp@pidgin.im>
parents: 6063
diff changeset
618 *
9083f92e0d58 [gaim-migrate @ 6739]
Nathan Walp <nwalp@pidgin.im>
parents: 6063
diff changeset
619 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist
9083f92e0d58 [gaim-migrate @ 6739]
Nathan Walp <nwalp@pidgin.im>
parents: 6063
diff changeset
620 */
9083f92e0d58 [gaim-migrate @ 6739]
Nathan Walp <nwalp@pidgin.im>
parents: 6063
diff changeset
621 GSList *gaim_find_buddies(GaimAccount *account, const char *name);
9083f92e0d58 [gaim-migrate @ 6739]
Nathan Walp <nwalp@pidgin.im>
parents: 6063
diff changeset
622
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
623
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
624 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
625 * Finds a group by name
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
626 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
627 * @param name The groups name
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
628 * @return The group or NULL if the group does not exist
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
629 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
630 GaimGroup *gaim_find_group(const char *name);
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
631
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
632 /**
6456
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
633 * Finds a chat by name.
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
634 *
6720
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
635 * @param account The chat's account.
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
636 * @param name The chat's name.
6456
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
637 *
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
638 * @return The chat, or @c NULL if the chat does not exist.
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
639 */
7118
bf630f7dfdcd [gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents: 7117
diff changeset
640 GaimChat *gaim_blist_find_chat(GaimAccount *account, const char *name);
6456
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
641
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
642 /**
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
643 * Returns the group of which the chat is a member.
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
644 *
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
645 * @param chat The chat.
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
646 *
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
647 * @return The parent group, or @c NULL if the chat is not in a group.
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
648 */
7125
208cb260d7a7 [gaim-migrate @ 7692]
Nathan Walp <nwalp@pidgin.im>
parents: 7118
diff changeset
649 GaimGroup *gaim_chat_get_group(GaimChat *chat);
6456
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
650
ccfdf9f2cdd1 [gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents: 6245
diff changeset
651 /**
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
652 * Returns the group of which the buddy is a member.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
653 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
654 * @param buddy The buddy
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
655 * @return The group or NULL if the buddy is not in a group
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
656 */
12088
980c877bd238 [gaim-migrate @ 14385]
Mark Doliner <mark@kingant.net>
parents: 12054
diff changeset
657 GaimGroup *gaim_buddy_get_group(GaimBuddy *buddy);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
658
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
659
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
660 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
661 * Returns a list of accounts that have buddies in this group
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
662 *
6720
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
663 * @param g The group
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
664 *
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
665 * @return A list of gaim_accounts
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
666 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
667 GSList *gaim_group_get_accounts(GaimGroup *g);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
668
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
669 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
670 * Determines whether an account owns any buddies in a given group
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
671 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
672 * @param g The group to search through.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
673 * @param account The account.
6720
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
674 *
41120df7ed94 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6695
diff changeset
675 * @return TRUE if there are any buddies in the group, or FALSE otherwise.
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
676 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
677 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
678
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
679 /**
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
680 * Called when an account gets signed on. Tells the UI to update all the
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
681 * buddies.
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
682 *
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
683 * @param account The account
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
684 */
5563
9eb5b13fd412 [gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents: 5497
diff changeset
685 void gaim_blist_add_account(GaimAccount *account);
5234
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
686
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
687
890b29f00b68 [gaim-migrate @ 5604]
Nathan Walp <nwalp@pidgin.im>
parents: 5228
diff changeset
688 /**
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
689 * Called when an account gets signed off. Sets the presence of all the buddies to 0
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
690 * and tells the UI to update them.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
691 *
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
692 * @param account The account
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
693 */
5563
9eb5b13fd412 [gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents: 5497
diff changeset
694 void gaim_blist_remove_account(GaimAccount *account);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
695
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
696
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
697 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
698 * Determines the total size of a group
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
699 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
700 * @param group The group
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
701 * @param offline Count buddies in offline accounts
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
702 * @return The number of buddies in the group
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
703 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
704 int gaim_blist_get_group_size(GaimGroup *group, gboolean offline);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
705
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
706 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
707 * Determines the number of online buddies in a group
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
708 *
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
709 * @param group The group
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
710 * @return The number of online buddies in the group, or 0 if the group is NULL
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
711 */
6695
0c5637b5462e [gaim-migrate @ 7221]
Nathan Walp <nwalp@pidgin.im>
parents: 6485
diff changeset
712 int gaim_blist_get_group_online_count(GaimGroup *group);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
713
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
714 /*@}*/
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
715
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
716 /****************************************************************************************/
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
717 /** @name Buddy list file management API */
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
718 /****************************************************************************************/
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
719
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
720 /**
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
721 * Loads the buddy list from ~/.gaim/blist.xml.
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
722 */
12323
fc464a0abccc [gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents: 12319
diff changeset
723 void gaim_blist_load(void);
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
724
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
725 /**
10704
a4ae4fb7f939 [gaim-migrate @ 12288]
Mark Doliner <mark@kingant.net>
parents: 10662
diff changeset
726 * Schedule a save of the blist.xml file. This is used by the privacy
a4ae4fb7f939 [gaim-migrate @ 12288]
Mark Doliner <mark@kingant.net>
parents: 10662
diff changeset
727 * API whenever the privacy settings are changed. If you make a change
a4ae4fb7f939 [gaim-migrate @ 12288]
Mark Doliner <mark@kingant.net>
parents: 10662
diff changeset
728 * to blist.xml using one of the functions in the buddy list API, then
a4ae4fb7f939 [gaim-migrate @ 12288]
Mark Doliner <mark@kingant.net>
parents: 10662
diff changeset
729 * the buddy list is saved automatically, so you should not need to
a4ae4fb7f939 [gaim-migrate @ 12288]
Mark Doliner <mark@kingant.net>
parents: 10662
diff changeset
730 * call this.
10350
d962fc7778f1 [gaim-migrate @ 11565]
Mark Doliner <mark@kingant.net>
parents: 10349
diff changeset
731 */
12323
fc464a0abccc [gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents: 12319
diff changeset
732 void gaim_blist_schedule_save(void);
10350
d962fc7778f1 [gaim-migrate @ 11565]
Mark Doliner <mark@kingant.net>
parents: 10349
diff changeset
733
d962fc7778f1 [gaim-migrate @ 11565]
Mark Doliner <mark@kingant.net>
parents: 10349
diff changeset
734 /**
7060
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
735 * Requests from the user information needed to add a buddy to the
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
736 * buddy list.
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
737 *
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
738 * @param account The account the buddy is added to.
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
739 * @param username The username of the buddy.
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
740 * @param group The name of the group to place the buddy in.
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
741 * @param alias The optional alias for the buddy.
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
742 */
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
743 void gaim_blist_request_add_buddy(GaimAccount *account, const char *username,
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
744 const char *group, const char *alias);
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
745
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
746 /**
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
747 * Requests from the user information needed to add a chat to the
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
748 * buddy list.
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
749 *
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
750 * @param account The account the buddy is added to.
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
751 * @param group The optional group to add the chat to.
9000
b540c735a6ad [gaim-migrate @ 9775]
Luke Schierer <lschiere@pidgin.im>
parents: 8952
diff changeset
752 * @param alias The optional alias for the chat.
9939
acbbc0d73600 [gaim-migrate @ 10831]
Ethan Blanton <elb@pidgin.im>
parents: 9927
diff changeset
753 * @param name The required chat name.
7060
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
754 */
7859
e873d0bd0e6c [gaim-migrate @ 8513]
Mark Doliner <mark@kingant.net>
parents: 7826
diff changeset
755 void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group,
9754
4a8bf81b82ae [gaim-migrate @ 10621]
Luke Schierer <lschiere@pidgin.im>
parents: 9713
diff changeset
756 const char *alias, const char *name);
7060
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
757
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
758 /**
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
759 * Requests from the user information needed to add a group to the
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
760 * buddy list.
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
761 */
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
762 void gaim_blist_request_add_group(void);
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
763
9946001989a3 [gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents: 7035
diff changeset
764 /**
7693
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
765 * Associates a boolean with a node in the buddy list
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
766 *
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
767 * @param node The node to associate the data with
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
768 * @param key The identifier for the data
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
769 * @param value The value to set
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
770 */
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
771 void gaim_blist_node_set_bool(GaimBlistNode *node, const char *key, gboolean value);
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
772
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
773 /**
8735
92cbf9713795 [gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents: 8710
diff changeset
774 * Retrieves a named boolean setting from a node in the buddy list
7693
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
775 *
8735
92cbf9713795 [gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents: 8710
diff changeset
776 * @param node The node to retrieve the data from
7693
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
777 * @param key The identifier of the data
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
778 *
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
779 * @return The value, or FALSE if there is no setting
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
780 */
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
781 gboolean gaim_blist_node_get_bool(GaimBlistNode *node, const char *key);
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
782
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
783 /**
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
784 * Associates an integer with a node in the buddy list
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
785 *
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
786 * @param node The node to associate the data with
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
787 * @param key The identifier for the data
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
788 * @param value The value to set
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
789 */
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
790 void gaim_blist_node_set_int(GaimBlistNode *node, const char *key, int value);
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
791
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
792 /**
8735
92cbf9713795 [gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents: 8710
diff changeset
793 * Retrieves a named integer setting from a node in the buddy list
7693
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
794 *
8735
92cbf9713795 [gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents: 8710
diff changeset
795 * @param node The node to retrieve the data from
7693
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
796 * @param key The identifier of the data
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
797 *
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
798 * @return The value, or 0 if there is no setting
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
799 */
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
800 int gaim_blist_node_get_int(GaimBlistNode *node, const char *key);
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
801
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
802 /**
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
803 * Associates a string with a node in the buddy list
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
804 *
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
805 * @param node The node to associate the data with
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
806 * @param key The identifier for the data
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
807 * @param value The value to set
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
808 */
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
809 void gaim_blist_node_set_string(GaimBlistNode *node, const char *key,
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
810 const char *value);
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
811
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
812 /**
8735
92cbf9713795 [gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents: 8710
diff changeset
813 * Retrieves a named string setting from a node in the buddy list
7693
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
814 *
8735
92cbf9713795 [gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents: 8710
diff changeset
815 * @param node The node to retrieve the data from
7693
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
816 * @param key The identifier of the data
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
817 *
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
818 * @return The value, or NULL if there is no setting
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
819 */
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
820 const char *gaim_blist_node_get_string(GaimBlistNode *node, const char *key);
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
821
1d0314b99747 [gaim-migrate @ 8338]
Nathan Walp <nwalp@pidgin.im>
parents: 7674
diff changeset
822 /**
7811
2e6e269504a4 [gaim-migrate @ 8458]
Ethan Blanton <elb@pidgin.im>
parents: 7693
diff changeset
823 * Removes a named setting from a blist node
2e6e269504a4 [gaim-migrate @ 8458]
Ethan Blanton <elb@pidgin.im>
parents: 7693
diff changeset
824 *
2e6e269504a4 [gaim-migrate @ 8458]
Ethan Blanton <elb@pidgin.im>
parents: 7693
diff changeset
825 * @param node The node from which to remove the setting
2e6e269504a4 [gaim-migrate @ 8458]
Ethan Blanton <elb@pidgin.im>
parents: 7693
diff changeset
826 * @param key The name of the setting
2e6e269504a4 [gaim-migrate @ 8458]
Ethan Blanton <elb@pidgin.im>
parents: 7693
diff changeset
827 */
2e6e269504a4 [gaim-migrate @ 8458]
Ethan Blanton <elb@pidgin.im>
parents: 7693
diff changeset
828 void gaim_blist_node_remove_setting(GaimBlistNode *node, const char *key);
2e6e269504a4 [gaim-migrate @ 8458]
Ethan Blanton <elb@pidgin.im>
parents: 7693
diff changeset
829
10548
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
830 /**
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
831 * Set the flags for the given node. Setting a node's flags will overwrite
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
832 * the old flags, so if you want to save them, you must first call
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
833 * gaim_blist_node_get_flags and modify that appropriately.
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
834 *
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
835 * @param node The node on which to set the flags.
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
836 * @param flags The flags to set. This is a bitmask.
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
837 */
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
838 void gaim_blist_node_set_flags(GaimBlistNode *node, GaimBlistNodeFlags flags);
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
839
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
840 /**
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
841 * Get the current flags on a given node.
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
842 *
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
843 * @param node The node from which to get the flags.
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
844 *
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
845 * @return The flags on the node. This is a bitmask.
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
846 */
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
847 GaimBlistNodeFlags gaim_blist_node_get_flags(GaimBlistNode *node);
1596ade00664 [gaim-migrate @ 11918]
Mark Doliner <mark@kingant.net>
parents: 10433
diff changeset
848
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
849 /*@}*/
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
850
8710
36b043fe2740 [gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
851
36b043fe2740 [gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
852 /**
9030
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
853 * Retrieves the extended menu items for a buddy list node.
12286
255e6912607b [gaim-migrate @ 14590]
Etan Reisner <pidgin@unreliablesource.net>
parents: 12112
diff changeset
854 * @param n The blist node for which to obtain the extended menu items.
255e6912607b [gaim-migrate @ 14590]
Etan Reisner <pidgin@unreliablesource.net>
parents: 12112
diff changeset
855 * @return A list of GaimBlistNodeAction items, as harvested by the
255e6912607b [gaim-migrate @ 14590]
Etan Reisner <pidgin@unreliablesource.net>
parents: 12112
diff changeset
856 * blist-node-extended-menu signal.
9030
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
857 */
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
858 GList *gaim_blist_node_get_extended_menu(GaimBlistNode *n);
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
859
8710
36b043fe2740 [gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
860
8952
e3f4657fa555 [gaim-migrate @ 9724]
Luke Schierer <lschiere@pidgin.im>
parents: 8735
diff changeset
861 /**
9030
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
862 * Creates a new GaimBlistNodeAction.
10662
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
863 * @param label The text label to display for this action.
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
864 * @param callback The function to be called when the action is used on
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
865 * a selected GaimBlistNode.
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
866 * @param data Additional data, to be passed to the callback
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
867 * @param children A GList of GaimBlistNodeActions to be added as a
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
868 * submenu of the action.
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
869 * @return The GaimBlistNodeAction.
9030
7ab20f829190 [gaim-migrate @ 9806]
Mark Doliner <mark@kingant.net>
parents: 9013
diff changeset
870 */
10662
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
871 GaimBlistNodeAction *gaim_blist_node_action_new(char *label,
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
872 void (*callback)(GaimBlistNode *, gpointer), gpointer data,
54ac161a876e [gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents: 10567
diff changeset
873 GList *children);
8952
e3f4657fa555 [gaim-migrate @ 9724]
Luke Schierer <lschiere@pidgin.im>
parents: 8735
diff changeset
874
8710
36b043fe2740 [gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
875
5228
1a53330dfd34 [gaim-migrate @ 5598]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
876 /**************************************************************************/
12054
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
877 /** @name UI Registration Functions */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
878 /**************************************************************************/
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
879 /*@{*/
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
880
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
881 /**
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
882 * Sets the UI operations structure to be used for the buddy list.
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
883 *
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
884 * @param ops The ops struct.
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
885 */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
886 void gaim_blist_set_ui_ops(GaimBlistUiOps *ops);
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
887
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
888 /**
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
889 * Returns the UI operations structure to be used for the buddy list.
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
890 *
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
891 * @return The UI operations structure.
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
892 */
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
893 GaimBlistUiOps *gaim_blist_get_ui_ops(void);
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
894
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
895 /*@}*/
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
896
2cb1beb9da51 [gaim-migrate @ 14349]
Nathan Walp <nwalp@pidgin.im>
parents: 12053
diff changeset
897 /**************************************************************************/
6485
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
898 /** @name Buddy List Subsystem */
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
899 /**************************************************************************/
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
900 /*@{*/
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
901
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
902 /**
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
903 * Returns the handle for the buddy list subsystem.
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
904 *
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
905 * @return The buddy list subsystem handle.
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
906 */
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
907 void *gaim_blist_get_handle(void);
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
908
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
909 /**
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
910 * Initializes the buddy list subsystem.
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
911 */
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
912 void gaim_blist_init(void);
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
913
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
914 /**
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
915 * Uninitializes the buddy list subsystem.
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
916 */
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
917 void gaim_blist_uninit(void);
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
918
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
919 /*@}*/
70d5122bc3ff [gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents: 6456
diff changeset
920
5944
158196b2db19 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5906
diff changeset
921 #ifdef __cplusplus
158196b2db19 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5906
diff changeset
922 }
158196b2db19 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5906
diff changeset
923 #endif
158196b2db19 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5906
diff changeset
924
9713
db62420a53a2 [gaim-migrate @ 10574]
Mark Doliner <mark@kingant.net>
parents: 9635
diff changeset
925 #endif /* _GAIM_BLIST_H_ */