pidgin 2.14.5

blist.h
Go to the documentation of this file.
1
7 /* purple
8 *
9 * Purple is the legal property of its developers, whose names are too numerous
10 * to list here. Please refer to the COPYRIGHT file distributed with this
11 * source distribution.
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
26 */
27 #ifndef _PURPLE_BLIST_H_
28 #define _PURPLE_BLIST_H_
29
30 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */
31
32 #include <glib.h>
33
35 typedef struct _PurpleBuddyList PurpleBuddyList;
37 typedef struct _PurpleBlistUiOps PurpleBlistUiOps;
39 typedef struct _PurpleBlistNode PurpleBlistNode;
40
42 typedef struct _PurpleChat PurpleChat;
44 typedef struct _PurpleGroup PurpleGroup;
46 typedef struct _PurpleContact PurpleContact;
48 typedef struct _PurpleBuddy PurpleBuddy;
49
50 /**************************************************************************/
51 /* Enumerations */
52 /**************************************************************************/
53 typedef enum
54 {
55 PURPLE_BLIST_GROUP_NODE,
56 PURPLE_BLIST_CONTACT_NODE,
57 PURPLE_BLIST_BUDDY_NODE,
58 PURPLE_BLIST_CHAT_NODE,
59 PURPLE_BLIST_OTHER_NODE
60
61 } PurpleBlistNodeType;
62
63 #define PURPLE_BLIST_NODE_IS_CHAT(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE)
64 #define PURPLE_BLIST_NODE_IS_BUDDY(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE)
65 #define PURPLE_BLIST_NODE_IS_CONTACT(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CONTACT_NODE)
66 #define PURPLE_BLIST_NODE_IS_GROUP(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_GROUP_NODE)
67
68 #define PURPLE_BUDDY_IS_ONLINE(b) \
69 ((b) != NULL && purple_account_is_connected(purple_buddy_get_account(b)) && \
70 purple_presence_is_online(purple_buddy_get_presence(b)))
71
72 typedef enum
73 {
74 PURPLE_BLIST_NODE_FLAG_NO_SAVE = 1 << 0,
75 PURPLE_BLIST_NODE_FLAG_INVISIBLE = 1 << 1,
77 } PurpleBlistNodeFlags;
78
82 #define PURPLE_BLIST_NODE(obj) ((PurpleBlistNode *)(obj))
83
84 #define PURPLE_BLIST_NODE_HAS_FLAG(b, f) (purple_blist_node_get_flags((PurpleBlistNode*)(b)) & (f))
85 #define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE))
86 #define PURPLE_BLIST_NODE_IS_VISIBLE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_INVISIBLE))
87
88 #define PURPLE_BLIST_NODE_NAME(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE ? purple_chat_get_name((PurpleChat*)n) : \
89 purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL)
90
94 #define PURPLE_GROUP(obj) ((PurpleGroup *)(obj))
95
99 #define PURPLE_CONTACT(obj) ((PurpleContact *)(obj))
100
104 #define PURPLE_BUDDY(obj) ((PurpleBuddy *)(obj))
105
109 #define PURPLE_CHAT(obj) ((PurpleChat *)(obj))
110
111 #include "account.h"
112 #include "buddyicon.h"
113 #include "media.h"
114 #include "status.h"
115
116 /**************************************************************************/
117 /* Data Structures */
118 /**************************************************************************/
119
120 #if !(defined PURPLE_HIDE_STRUCTS) || (defined _PURPLE_BLIST_C_)
121
126 struct _PurpleBlistNode {
127 PurpleBlistNodeType type;
128 PurpleBlistNode *prev;
129 PurpleBlistNode *next;
130 PurpleBlistNode *parent;
131 PurpleBlistNode *child;
132 GHashTable *settings;
133 void *ui_data;
134 PurpleBlistNodeFlags flags;
135 };
136
140 struct _PurpleBuddy {
141 PurpleBlistNode node;
142 char *name;
143 char *alias;
144 char *server_alias;
145 void *proto_data;
146 PurpleBuddyIcon *icon;
147 PurpleAccount *account;
148 PurplePresence *presence;
149 PurpleMediaCaps media_caps;
150 };
151
155 struct _PurpleContact {
156 PurpleBlistNode node;
157 char *alias;
158 int totalsize;
159 int currentsize;
160 int online;
161 PurpleBuddy *priority;
162 gboolean priority_valid;
163 };
164
165
169 struct _PurpleGroup {
170 PurpleBlistNode node;
171 char *name;
172 int totalsize;
173 int currentsize;
174 int online;
175 };
176
181 struct _PurpleChat {
182 PurpleBlistNode node;
183 char *alias;
184 GHashTable *components;
185 PurpleAccount *account;
186 };
187
191 struct _PurpleBuddyList {
192 PurpleBlistNode *root;
193 GHashTable *buddies;
194 void *ui_data;
195 };
196
197 #endif /* PURPLE_HIDE_STRUCTS && PURPLE_BLIST_STRUCTS */
198
205 struct _PurpleBlistUiOps
206 {
207 void (*new_list)(PurpleBuddyList *list);
208 void (*new_node)(PurpleBlistNode *node);
209 void (*show)(PurpleBuddyList *list);
210 void (*update)(PurpleBuddyList *list,
211 PurpleBlistNode *node);
212 void (*remove)(PurpleBuddyList *list,
213 PurpleBlistNode *node);
214 void (*destroy)(PurpleBuddyList *list);
215 void (*set_visible)(PurpleBuddyList *list,
216 gboolean show);
217 void (*request_add_buddy)(PurpleAccount *account, const char *username,
218 const char *group, const char *alias);
219 void (*request_add_chat)(PurpleAccount *account, PurpleGroup *group,
220 const char *alias, const char *name);
221 void (*request_add_group)(void);
222
234 void (*save_node)(PurpleBlistNode *node);
235
248 void (*remove_node)(PurpleBlistNode *node);
249
263 void (*save_account)(PurpleAccount *account);
264
265 void (*_purple_reserved1)(void);
266 };
267
268 #ifdef __cplusplus
269 extern "C" {
270 #endif
271
272 /**************************************************************************/
274 /**************************************************************************/
283 PurpleBuddyList *purple_blist_new(void);
284
291 void purple_set_blist(PurpleBuddyList *blist);
292
298 PurpleBuddyList *purple_get_blist(void);
299
305 PurpleBlistNode *purple_blist_get_root(void);
306
318 GSList *purple_blist_get_buddies(void);
319
327 gpointer purple_blist_get_ui_data(void);
328
336 void purple_blist_set_ui_data(gpointer ui_data);
337
350 PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
351
363 PurpleBlistNode *purple_blist_node_get_parent(PurpleBlistNode *node);
364
376 PurpleBlistNode *purple_blist_node_get_first_child(PurpleBlistNode *node);
377
389 PurpleBlistNode *purple_blist_node_get_sibling_next(PurpleBlistNode *node);
390
402 PurpleBlistNode *purple_blist_node_get_sibling_prev(PurpleBlistNode *node);
403
411 gpointer purple_blist_node_get_ui_data(const PurpleBlistNode *node);
412
421 void purple_blist_node_set_ui_data(PurpleBlistNode *node, gpointer ui_data);
422
426 void purple_blist_show(void);
427
428
436 void purple_blist_destroy(void);
437
443 void purple_blist_set_visible(gboolean show);
444
453 void purple_blist_update_buddy_status(PurpleBuddy *buddy, PurpleStatus *old_status);
454
462 void purple_blist_update_node_icon(PurpleBlistNode *node);
463
464 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
465
471 void purple_blist_update_buddy_icon(PurpleBuddy *buddy);
472 #endif
473
480 void purple_blist_rename_buddy(PurpleBuddy *buddy, const char *name);
481
488 void purple_blist_alias_contact(PurpleContact *contact, const char *alias);
489
496 void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias);
497
505 void purple_blist_server_alias_buddy(PurpleBuddy *buddy, const char *alias);
506
513 void purple_blist_alias_chat(PurpleChat *chat, const char *alias);
514
521 void purple_blist_rename_group(PurpleGroup *group, const char *name);
522
533 PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);
534
540 void purple_chat_destroy(PurpleChat *chat);
541
553 void purple_blist_add_chat(PurpleChat *chat, PurpleGroup *group, PurpleBlistNode *node);
554
570 PurpleBuddy *purple_buddy_new(PurpleAccount *account, const char *name, const char *alias);
571
577 void purple_buddy_destroy(PurpleBuddy *buddy);
578
590 void purple_buddy_set_icon(PurpleBuddy *buddy, PurpleBuddyIcon *icon);
591
599 PurpleAccount *purple_buddy_get_account(const PurpleBuddy *buddy);
600
608 const char *purple_buddy_get_name(const PurpleBuddy *buddy);
609
617 PurpleBuddyIcon *purple_buddy_get_icon(const PurpleBuddy *buddy);
618
630 gpointer purple_buddy_get_protocol_data(const PurpleBuddy *buddy);
631
643 void purple_buddy_set_protocol_data(PurpleBuddy *buddy, gpointer data);
644
652 PurpleContact *purple_buddy_get_contact(PurpleBuddy *buddy);
653
661 PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy);
662
671 PurpleMediaCaps purple_buddy_get_media_caps(const PurpleBuddy *buddy);
672
679 void purple_buddy_set_media_caps(PurpleBuddy *buddy, PurpleMediaCaps media_caps);
680
694 void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
695
705 PurpleGroup *purple_group_new(const char *name);
706
712 void purple_group_destroy(PurpleGroup *group);
713
723 void purple_blist_add_group(PurpleGroup *group, PurpleBlistNode *node);
724
730 PurpleContact *purple_contact_new(void);
731
737 void purple_contact_destroy(PurpleContact *contact);
738
747 PurpleGroup *purple_contact_get_group(const PurpleContact *contact);
748
759 void purple_blist_add_contact(PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
760
769 void purple_blist_merge_contact(PurpleContact *source, PurpleBlistNode *node);
770
777 PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact);
778
779 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
780
788 void purple_contact_set_alias(PurpleContact *contact, const char *alias);
789 #endif
790
797 const char *purple_contact_get_alias(PurpleContact *contact);
798
807 gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account);
808
815 void purple_contact_invalidate_priority_buddy(PurpleContact *contact);
816
825 void purple_blist_remove_buddy(PurpleBuddy *buddy);
826
836 void purple_blist_remove_contact(PurpleContact *contact);
837
843 void purple_blist_remove_chat(PurpleChat *chat);
844
851 void purple_blist_remove_group(PurpleGroup *group);
852
860 const char *purple_buddy_get_alias_only(PurpleBuddy *buddy);
861
868 const char *purple_buddy_get_server_alias(PurpleBuddy *buddy);
869
879 const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy);
880
881 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
882
891 const char *purple_buddy_get_local_alias(PurpleBuddy *buddy);
892 #endif
893
902 const char *purple_buddy_get_alias(PurpleBuddy *buddy);
903
912 const char *purple_buddy_get_local_buddy_alias(PurpleBuddy *buddy);
913
920 const char *purple_chat_get_name(PurpleChat *chat);
921
929 PurpleBuddy *purple_find_buddy(PurpleAccount *account, const char *name);
930
939 PurpleBuddy *purple_find_buddy_in_group(PurpleAccount *account, const char *name,
940 PurpleGroup *group);
941
950 GSList *purple_find_buddies(PurpleAccount *account, const char *name);
951
952
959 PurpleGroup *purple_find_group(const char *name);
960
969 PurpleChat *purple_blist_find_chat(PurpleAccount *account, const char *name);
970
978 PurpleGroup *purple_chat_get_group(PurpleChat *chat);
979
989 PurpleAccount *purple_chat_get_account(PurpleChat *chat);
990
1000 GHashTable *purple_chat_get_components(PurpleChat *chat);
1001
1008 PurpleGroup *purple_buddy_get_group(PurpleBuddy *buddy);
1009
1010
1019 GSList *purple_group_get_accounts(PurpleGroup *g);
1020
1029 gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account);
1030
1038 const char *purple_group_get_name(PurpleGroup *group);
1039
1046 void purple_blist_add_account(PurpleAccount *account);
1047
1048
1055 void purple_blist_remove_account(PurpleAccount *account);
1056
1057
1065 int purple_blist_get_group_size(PurpleGroup *group, gboolean offline);
1066
1073 int purple_blist_get_group_online_count(PurpleGroup *group);
1074
1077 /****************************************************************************************/
1079 /****************************************************************************************/
1080
1084 void purple_blist_load(void);
1085
1093 void purple_blist_schedule_save(void);
1094
1104 void purple_blist_request_add_buddy(PurpleAccount *account, const char *username,
1105 const char *group, const char *alias);
1106
1116 void purple_blist_request_add_chat(PurpleAccount *account, PurpleGroup *group,
1117 const char *alias, const char *name);
1118
1123 void purple_blist_request_add_group(void);
1124
1132 void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value);
1133
1142 gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key);
1143
1151 void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value);
1152
1161 int purple_blist_node_get_int(PurpleBlistNode *node, const char *key);
1162
1170 void purple_blist_node_set_string(PurpleBlistNode *node, const char *key,
1171 const char *value);
1172
1181 const char *purple_blist_node_get_string(PurpleBlistNode *node, const char *key);
1182
1189 void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key);
1190
1199 void purple_blist_node_set_flags(PurpleBlistNode *node, PurpleBlistNodeFlags flags);
1200
1208 PurpleBlistNodeFlags purple_blist_node_get_flags(PurpleBlistNode *node);
1209
1219 PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node);
1220
1229 GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n);
1230
1231 /**************************************************************************/
1233 /**************************************************************************/
1241 void purple_blist_set_ui_ops(PurpleBlistUiOps *ops);
1242
1248 PurpleBlistUiOps *purple_blist_get_ui_ops(void);
1249
1252 /**************************************************************************/
1254 /**************************************************************************/
1262 void *purple_blist_get_handle(void);
1263
1267 void purple_blist_init(void);
1268
1272 void purple_blist_uninit(void);
1273
1276 #ifdef __cplusplus
1277 }
1278 #endif
1279
1280 #endif /* _PURPLE_BLIST_H_ */
purple_blist_rename_group
void purple_blist_rename_group(PurpleGroup *group, const char *name)
Renames a group.
PurpleBlistNodeFlags
PurpleBlistNodeFlags
Definition: blist.h:72
purple_get_blist
PurpleBuddyList * purple_get_blist(void)
Returns the main buddy list.
_PurpleContact::priority_valid
gboolean priority_valid
Is priority valid?
Definition: blist.h:162
purple_blist_node_set_bool
void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value)
Associates a boolean with a node in the buddy list.
purple_blist_get_root
PurpleBlistNode * purple_blist_get_root(void)
Returns the root node of the main buddy list.
_PurpleBlistNode::next
PurpleBlistNode * next
The sibling after this buddy.
Definition: blist.h:129
purple_blist_uninit
void purple_blist_uninit(void)
Uninitializes the buddy list subsystem.
_PurpleContact::priority
PurpleBuddy * priority
The "top" buddy for this contact.
Definition: blist.h:161
purple_blist_schedule_save
void purple_blist_schedule_save(void)
Schedule a save of the blist.xml file.
purple_buddy_set_media_caps
void purple_buddy_set_media_caps(PurpleBuddy *buddy, PurpleMediaCaps media_caps)
Sets the media caps for a buddy.
purple_group_new
PurpleGroup * purple_group_new(const char *name)
Creates a new group.
_PurpleBlistUiOps::remove
void(* remove)(PurpleBuddyList *list, PurpleBlistNode *node)
This removes a node from the list.
Definition: blist.h:212
purple_blist_node_get_type
PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node)
Get the type of a given node.
purple_contact_invalidate_priority_buddy
void purple_contact_invalidate_priority_buddy(PurpleContact *contact)
Invalidates the priority buddy so that the next call to purple_contact_get_priority_buddy recomputes ...
purple_blist_remove_contact
void purple_blist_remove_contact(PurpleContact *contact)
Removes a contact, and any buddies it contains, and frees the memory allocated to it.
purple_buddy_get_contact_alias
const char * purple_buddy_get_contact_alias(PurpleBuddy *buddy)
Returns the correct name to display for a buddy, taking the contact alias into account.
purple_blist_get_group_size
int purple_blist_get_group_size(PurpleGroup *group, gboolean offline)
Determines the total size of a group.
purple_chat_get_account
PurpleAccount * purple_chat_get_account(PurpleChat *chat)
Returns the account the chat belongs to.
purple_blist_node_get_extended_menu
GList * purple_blist_node_get_extended_menu(PurpleBlistNode *n)
Retrieves the extended menu items for a buddy list node.
account.h
purple_blist_node_get_flags
PurpleBlistNodeFlags purple_blist_node_get_flags(PurpleBlistNode *node)
Get the current flags on a given node.
purple_blist_node_get_ui_data
gpointer purple_blist_node_get_ui_data(const PurpleBlistNode *node)
Returns the UI data of a given node.
_PurpleBuddyList::root
PurpleBlistNode * root
The first node in the buddy list.
Definition: blist.h:192
media.h
_PurpleBuddy::name
char * name
The name of the buddy.
Definition: blist.h:142
_PurpleBlistUiOps::update
void(* update)(PurpleBuddyList *list, PurpleBlistNode *node)
This will update a node in the buddy list.
Definition: blist.h:210
purple_blist_add_buddy
void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node)
Adds a new buddy to the buddy list.
purple_blist_remove_chat
void purple_blist_remove_chat(PurpleChat *chat)
Removes a chat from the buddy list and frees the memory allocated to it.
purple_buddy_get_server_alias
const char * purple_buddy_get_server_alias(PurpleBuddy *buddy)
Gets the server alias for a buddy.
purple_contact_get_priority_buddy
PurpleBuddy * purple_contact_get_priority_buddy(PurpleContact *contact)
Returns the highest priority buddy for a given contact.
_PurpleBuddyList::buddies
GHashTable * buddies
Every buddy in this list.
Definition: blist.h:193
_PurpleContact::alias
char * alias
The user-set alias of the contact.
Definition: blist.h:157
purple_blist_node_get_string
const char * purple_blist_node_get_string(PurpleBlistNode *node, const char *key)
Retrieves a named string setting from a node in the buddy list.
_PurpleBuddy::media_caps
PurpleMediaCaps media_caps
The media capabilities of the buddy.
Definition: blist.h:149
purple_blist_node_get_int
int purple_blist_node_get_int(PurpleBlistNode *node, const char *key)
Retrieves a named integer setting from a node in the buddy list.
_PurpleBuddy::node
PurpleBlistNode node
The node that this buddy inherits from.
Definition: blist.h:141
purple_chat_get_group
PurpleGroup * purple_chat_get_group(PurpleChat *chat)
Returns the group of which the chat is a member.
purple_blist_destroy
void purple_blist_destroy(void)
Destroys the buddy list window.
purple_blist_node_set_string
void purple_blist_node_set_string(PurpleBlistNode *node, const char *key, const char *value)
Associates a string with a node in the buddy list.
purple_buddy_get_contact
PurpleContact * purple_buddy_get_contact(PurpleBuddy *buddy)
Returns a buddy's contact.
_PurpleGroup::name
char * name
The name of this group.
Definition: blist.h:171
purple_chat_get_name
const char * purple_chat_get_name(PurpleChat *chat)
Returns the correct name to display for a blist chat.
purple_buddy_get_media_caps
PurpleMediaCaps purple_buddy_get_media_caps(const PurpleBuddy *buddy)
Gets the media caps from a buddy.
purple_blist_new
PurpleBuddyList * purple_blist_new(void)
Creates a new buddy list.
purple_find_group
PurpleGroup * purple_find_group(const char *name)
Finds a group by name.
_PurpleGroup::totalsize
int totalsize
The number of chats and contacts in this group.
Definition: blist.h:172
_PurpleGroup::currentsize
int currentsize
The number of chats and contacts in this group corresponding to online accounts.
Definition: blist.h:173
purple_group_destroy
void purple_group_destroy(PurpleGroup *group)
Destroys a group.
purple_blist_add_account
void purple_blist_add_account(PurpleAccount *account)
Called when an account connects.
purple_buddy_get_account
PurpleAccount * purple_buddy_get_account(const PurpleBuddy *buddy)
Returns a buddy's account.
purple_blist_set_visible
void purple_blist_set_visible(gboolean show)
Hides or unhides the buddy list.
purple_blist_get_buddies
GSList * purple_blist_get_buddies(void)
Returns a list of every buddy in the list.
purple_find_buddy_in_group
PurpleBuddy * purple_find_buddy_in_group(PurpleAccount *account, const char *name, PurpleGroup *group)
Finds the buddy struct given a name, an account, and a group.
purple_blist_remove_buddy
void purple_blist_remove_buddy(PurpleBuddy *buddy)
Removes a buddy from the buddy list and frees the memory allocated to it.
_PurpleBuddy::server_alias
char * server_alias
The server-specified alias of the buddy.
Definition: blist.h:144
purple_blist_remove_group
void purple_blist_remove_group(PurpleGroup *group)
Removes a group from the buddy list and frees the memory allocated to it and to its children.
purple_blist_set_ui_ops
void purple_blist_set_ui_ops(PurpleBlistUiOps *ops)
Sets the UI operations structure to be used for the buddy list.
purple_blist_node_remove_setting
void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key)
Removes a named setting from a blist node.
_PurpleContact::totalsize
int totalsize
The number of buddies in this contact.
Definition: blist.h:158
_PurpleBuddy::proto_data
void * proto_data
This allows the prpl to associate whatever data it wants with a buddy.
Definition: blist.h:145
_PurpleChat::alias
char * alias
The display name of this chat.
Definition: blist.h:183
purple_chat_get_components
GHashTable * purple_chat_get_components(PurpleChat *chat)
Get a hashtable containing information about a chat.
purple_blist_get_handle
void * purple_blist_get_handle(void)
Returns the handle for the buddy list subsystem.
purple_contact_destroy
void purple_contact_destroy(PurpleContact *contact)
Destroys a contact.
purple_blist_node_set_ui_data
void purple_blist_node_set_ui_data(PurpleBlistNode *node, gpointer ui_data)
Sets the UI data of a given node.
purple_buddy_new
PurpleBuddy * purple_buddy_new(PurpleAccount *account, const char *name, const char *alias)
Creates a new buddy.
purple_contact_set_alias
void purple_contact_set_alias(PurpleContact *contact, const char *alias)
Sets the alias for a contact.
purple_blist_add_group
void purple_blist_add_group(PurpleGroup *group, PurpleBlistNode *node)
Adds a new group to the buddy list.
purple_blist_find_chat
PurpleChat * purple_blist_find_chat(PurpleAccount *account, const char *name)
Finds a chat by name.
purple_blist_node_next
PurpleBlistNode * purple_blist_node_next(PurpleBlistNode *node, gboolean offline)
Returns the next node of a given node.
purple_buddy_get_presence
PurplePresence * purple_buddy_get_presence(const PurpleBuddy *buddy)
Returns a buddy's presence.
purple_blist_server_alias_buddy
void purple_blist_server_alias_buddy(PurpleBuddy *buddy, const char *alias)
Sets the server-sent alias of a buddy in the buddy list.
PURPLE_BLIST_NODE_FLAG_INVISIBLE
@ PURPLE_BLIST_NODE_FLAG_INVISIBLE
node should not be displayed
Definition: blist.h:75
_PurpleChat::account
PurpleAccount * account
The account this chat is attached to.
Definition: blist.h:185
purple_contact_new
PurpleContact * purple_contact_new(void)
Creates a new contact.
purple_blist_load
void purple_blist_load(void)
Loads the buddy list from ~/.purple/blist.xml.
purple_blist_node_set_flags
void purple_blist_node_set_flags(PurpleBlistNode *node, PurpleBlistNodeFlags flags)
Set the flags for the given node.
purple_blist_rename_buddy
void purple_blist_rename_buddy(PurpleBuddy *buddy, const char *name)
Renames a buddy in the buddy list.
purple_contact_get_alias
const char * purple_contact_get_alias(PurpleContact *contact)
Gets the alias for a contact.
purple_blist_merge_contact
void purple_blist_merge_contact(PurpleContact *source, PurpleBlistNode *node)
Merges two contacts.
purple_blist_add_contact
void purple_blist_add_contact(PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node)
Adds a new contact to the buddy list.
_PurpleAccount
Structure representing an account.
Definition: account.h:169
purple_find_buddies
GSList * purple_find_buddies(PurpleAccount *account, const char *name)
Finds all PurpleBuddy structs given a name and an account.
_PurpleBlistNode
A Buddy list node.
Definition: blist.h:126
purple_buddy_get_local_alias
const char * purple_buddy_get_local_alias(PurpleBuddy *buddy)
Returns the correct alias for this user, ignoring server aliases.
_PurpleBlistUiOps::save_account
void(* save_account)(PurpleAccount *account)
Called to save all the data for an account.
Definition: blist.h:263
purple_blist_update_node_icon
void purple_blist_update_node_icon(PurpleBlistNode *node)
Updates a node's custom icon.
_PurpleBlistNode::settings
GHashTable * settings
per-node settings
Definition: blist.h:132
_PurpleContact::online
int online
The number of buddies in this contact who are currently online.
Definition: blist.h:160
_PurpleChat::components
GHashTable * components
the stuff the protocol needs to know to join the chat
Definition: blist.h:184
purple_blist_remove_account
void purple_blist_remove_account(PurpleAccount *account)
Called when an account disconnects.
_PurpleBlistNode::child
PurpleBlistNode * child
The child of this node
Definition: blist.h:131
PURPLE_BLIST_NODE_FLAG_NO_SAVE
@ PURPLE_BLIST_NODE_FLAG_NO_SAVE
node should not be saved with the buddy list
Definition: blist.h:74
purple_blist_node_get_sibling_next
PurpleBlistNode * purple_blist_node_get_sibling_next(PurpleBlistNode *node)
Returns the sibling node of a given node.
purple_blist_alias_buddy
void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias)
Aliases a buddy in the buddy list.
purple_blist_set_ui_data
void purple_blist_set_ui_data(gpointer ui_data)
Sets the UI data for the list.
purple_blist_request_add_chat
void purple_blist_request_add_chat(PurpleAccount *account, PurpleGroup *group, const char *alias, const char *name)
Requests from the user information needed to add a chat to the buddy list.
purple_buddy_get_icon
PurpleBuddyIcon * purple_buddy_get_icon(const PurpleBuddy *buddy)
Returns a buddy's icon.
purple_blist_init
void purple_blist_init(void)
Initializes the buddy list subsystem.
_PurpleBlistNode::ui_data
void * ui_data
The UI can put data here.
Definition: blist.h:133
_PurpleBlistNode::prev
PurpleBlistNode * prev
The sibling before this buddy.
Definition: blist.h:128
_PurpleBlistUiOps::set_visible
void(* set_visible)(PurpleBuddyList *list, gboolean show)
Hides or unhides the buddy list.
Definition: blist.h:215
purple_blist_add_chat
void purple_blist_add_chat(PurpleChat *chat, PurpleGroup *group, PurpleBlistNode *node)
Adds a new chat to the buddy list.
purple_blist_node_get_parent
PurpleBlistNode * purple_blist_node_get_parent(PurpleBlistNode *node)
Returns the parent node of a given node.
_PurpleGroup
A group.
Definition: blist.h:169
_PurpleContact::currentsize
int currentsize
The number of buddies in this contact corresponding to online accounts.
Definition: blist.h:159
purple_buddy_get_alias_only
const char * purple_buddy_get_alias_only(PurpleBuddy *buddy)
Returns the alias of a buddy.
_PurpleGroup::node
PurpleBlistNode node
The node that this group inherits from.
Definition: blist.h:170
PurpleBuddyIcon
struct _PurpleBuddyIcon PurpleBuddyIcon
An opaque structure representing a buddy icon for a particular user on a particular PurpleAccount.
Definition: buddyicon.h:34
purple_blist_node_get_first_child
PurpleBlistNode * purple_blist_node_get_first_child(PurpleBlistNode *node)
Returns the the first child node of a given node.
purple_buddy_destroy
void purple_buddy_destroy(PurpleBuddy *buddy)
Destroys a buddy.
purple_buddy_get_local_buddy_alias
const char * purple_buddy_get_local_buddy_alias(PurpleBuddy *buddy)
Returns the local alias for the buddy, or NULL if none exists.
_PurpleBlistNode::type
PurpleBlistNodeType type
The type of node this is
Definition: blist.h:127
_PurpleBlistUiOps::remove_node
void(* remove_node)(PurpleBlistNode *node)
Called when a node is about to be removed from the buddy list.
Definition: blist.h:248
_PurpleChat::node
PurpleBlistNode node
The node that this chat inherits from.
Definition: blist.h:182
purple_buddy_get_protocol_data
gpointer purple_buddy_get_protocol_data(const PurpleBuddy *buddy)
Returns a buddy's protocol-specific data.
purple_blist_request_add_group
void purple_blist_request_add_group(void)
Requests from the user information needed to add a group to the buddy list.
purple_contact_get_group
PurpleGroup * purple_contact_get_group(const PurpleContact *contact)
Gets the PurpleGroup from a PurpleContact.
purple_buddy_get_group
PurpleGroup * purple_buddy_get_group(PurpleBuddy *buddy)
Returns the group of which the buddy is a member.
purple_blist_update_buddy_icon
void purple_blist_update_buddy_icon(PurpleBuddy *buddy)
Updates a buddy's icon.
purple_blist_get_group_online_count
int purple_blist_get_group_online_count(PurpleGroup *group)
Determines the number of online buddies in a group.
_PurpleBlistNode::parent
PurpleBlistNode * parent
The parent of this node
Definition: blist.h:130
_PurpleBlistUiOps::save_node
void(* save_node)(PurpleBlistNode *node)
This is called when a node has been modified and should be saved.
Definition: blist.h:234
_PurpleContact
A contact.
Definition: blist.h:155
purple_chat_destroy
void purple_chat_destroy(PurpleChat *chat)
Destroys a chat.
_PurpleBlistUiOps::new_node
void(* new_node)(PurpleBlistNode *node)
Sets UI-specific data on a node.
Definition: blist.h:208
purple_group_on_account
gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account)
Determines whether an account owns any buddies in a given group.
_PurpleChat
A chat.
Definition: blist.h:181
purple_buddy_get_name
const char * purple_buddy_get_name(const PurpleBuddy *buddy)
Returns a buddy's name.
_PurpleBlistUiOps::destroy
void(* destroy)(PurpleBuddyList *list)
When the list is destroyed, this is called to destroy the UI.
Definition: blist.h:214
buddyicon.h
purple_set_blist
void purple_set_blist(PurpleBuddyList *blist)
Sets the main buddy list.
_PurpleBlistUiOps
Buddy list UI operations.
Definition: blist.h:205
_PurpleBuddy::alias
char * alias
The user-set alias of the buddy.
Definition: blist.h:143
purple_buddy_get_alias
const char * purple_buddy_get_alias(PurpleBuddy *buddy)
Returns the correct name to display for a buddy.
purple_blist_get_ui_data
gpointer purple_blist_get_ui_data(void)
Returns the UI data for the list.
purple_blist_node_get_sibling_prev
PurpleBlistNode * purple_blist_node_get_sibling_prev(PurpleBlistNode *node)
Returns the previous sibling node of a given node.
purple_buddy_set_protocol_data
void purple_buddy_set_protocol_data(PurpleBuddy *buddy, gpointer data)
Sets a buddy's protocol-specific data.
purple_buddy_set_icon
void purple_buddy_set_icon(PurpleBuddy *buddy, PurpleBuddyIcon *icon)
Sets a buddy's icon.
_PurpleBuddy::icon
PurpleBuddyIcon * icon
The buddy icon.
Definition: blist.h:146
_PurpleBlistUiOps::new_list
void(* new_list)(PurpleBuddyList *list)
Sets UI-specific data on a buddy list.
Definition: blist.h:207
purple_blist_update_buddy_status
void purple_blist_update_buddy_status(PurpleBuddy *buddy, PurpleStatus *old_status)
Updates a buddy's status.
purple_blist_alias_contact
void purple_blist_alias_contact(PurpleContact *contact, const char *alias)
Aliases a contact in the buddy list.
_PurpleBuddy::account
PurpleAccount * account
the account this buddy belongs to
Definition: blist.h:147
_PurpleGroup::online
int online
The number of chats and contacts in this group who are currently online.
Definition: blist.h:174
purple_blist_get_ui_ops
PurpleBlistUiOps * purple_blist_get_ui_ops(void)
Returns the UI operations structure to be used for the buddy list.
_PurpleBlistUiOps::show
void(* show)(PurpleBuddyList *list)
The core will call this when it's finished doing its core stuff.
Definition: blist.h:209
purple_group_get_accounts
GSList * purple_group_get_accounts(PurpleGroup *g)
Returns a list of accounts that have buddies in this group.
purple_blist_show
void purple_blist_show(void)
Shows the buddy list, creating a new one if necessary.
_PurpleBuddy
A buddy.
Definition: blist.h:140
purple_blist_request_add_buddy
void purple_blist_request_add_buddy(PurpleAccount *account, const char *username, const char *group, const char *alias)
Requests from the user information needed to add a buddy to the buddy list.
purple_chat_new
PurpleChat * purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components)
Creates a new chat for the buddy list.
purple_blist_alias_chat
void purple_blist_alias_chat(PurpleChat *chat, const char *alias)
Aliases a chat in the buddy list.
purple_contact_on_account
gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account)
Determines whether an account owns any buddies in a given contact.
status.h
purple_find_buddy
PurpleBuddy * purple_find_buddy(PurpleAccount *account, const char *name)
Finds the buddy struct given a name and an account.
purple_group_get_name
const char * purple_group_get_name(PurpleGroup *group)
Returns the name of a group.
_PurpleBuddyList
The Buddy List.
Definition: blist.h:191
purple_blist_node_get_bool
gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key)
Retrieves a named boolean setting from a node in the buddy list.
purple_blist_node_set_int
void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value)
Associates an integer with a node in the buddy list.
_PurpleContact::node
PurpleBlistNode node
The node that this contact inherits from.
Definition: blist.h:156
_PurpleBuddyList::ui_data
void * ui_data
UI-specific data.
Definition: blist.h:194
_PurpleBlistNode::flags
PurpleBlistNodeFlags flags
The buddy flags
Definition: blist.h:134