00001
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027 #ifndef _PURPLE_BLIST_H_
00028 #define _PURPLE_BLIST_H_
00029
00030
00031
00032 #include <glib.h>
00033
00035 typedef struct _PurpleBuddyList PurpleBuddyList;
00037 typedef struct _PurpleBlistUiOps PurpleBlistUiOps;
00039 typedef struct _PurpleBlistNode PurpleBlistNode;
00040
00042 typedef struct _PurpleChat PurpleChat;
00044 typedef struct _PurpleGroup PurpleGroup;
00046 typedef struct _PurpleContact PurpleContact;
00048 typedef struct _PurpleBuddy PurpleBuddy;
00049
00050
00051
00052
00053 typedef enum
00054 {
00055 PURPLE_BLIST_GROUP_NODE,
00056 PURPLE_BLIST_CONTACT_NODE,
00057 PURPLE_BLIST_BUDDY_NODE,
00058 PURPLE_BLIST_CHAT_NODE,
00059 PURPLE_BLIST_OTHER_NODE
00060
00061 } PurpleBlistNodeType;
00062
00063 #define PURPLE_BLIST_NODE_IS_CHAT(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE)
00064 #define PURPLE_BLIST_NODE_IS_BUDDY(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE)
00065 #define PURPLE_BLIST_NODE_IS_CONTACT(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CONTACT_NODE)
00066 #define PURPLE_BLIST_NODE_IS_GROUP(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_GROUP_NODE)
00067
00068 #define PURPLE_BUDDY_IS_ONLINE(b) \
00069 ((b) != NULL && purple_account_is_connected(purple_buddy_get_account(b)) && \
00070 purple_presence_is_online(purple_buddy_get_presence(b)))
00071
00072 typedef enum
00073 {
00074 PURPLE_BLIST_NODE_FLAG_NO_SAVE = 1 << 0
00076 } PurpleBlistNodeFlags;
00077
00081 #define PURPLE_BLIST_NODE(obj) ((PurpleBlistNode *)(obj))
00082
00083 #define PURPLE_BLIST_NODE_HAS_FLAG(b, f) (purple_blist_node_get_flags((PurpleBlistNode*)(b)) & (f))
00084 #define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE))
00085
00086 #define PURPLE_BLIST_NODE_NAME(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE ? purple_chat_get_name((PurpleChat*)n) : \
00087 purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL)
00088
00092 #define PURPLE_GROUP(obj) ((PurpleGroup *)(obj))
00093
00097 #define PURPLE_CONTACT(obj) ((PurpleContact *)(obj))
00098
00102 #define PURPLE_BUDDY(obj) ((PurpleBuddy *)(obj))
00103
00107 #define PURPLE_CHAT(obj) ((PurpleChat *)(obj))
00108
00109 #include "account.h"
00110 #include "buddyicon.h"
00111 #include "status.h"
00112
00113
00114
00115
00116
00117 #if !(defined PURPLE_HIDE_STRUCTS) || (defined _PURPLE_BLIST_C_)
00118
00123 struct _PurpleBlistNode {
00124 PurpleBlistNodeType type;
00125 PurpleBlistNode *prev;
00126 PurpleBlistNode *next;
00127 PurpleBlistNode *parent;
00128 PurpleBlistNode *child;
00129 GHashTable *settings;
00130 void *ui_data;
00131 PurpleBlistNodeFlags flags;
00132 };
00133
00137 struct _PurpleBuddy {
00138 PurpleBlistNode node;
00139 char *name;
00140 char *alias;
00141 char *server_alias;
00142 void *proto_data;
00143 PurpleBuddyIcon *icon;
00144 PurpleAccount *account;
00145 PurplePresence *presence;
00146 };
00147
00151 struct _PurpleContact {
00152 PurpleBlistNode node;
00153 char *alias;
00154 int totalsize;
00155 int currentsize;
00156 int online;
00157 PurpleBuddy *priority;
00158 gboolean priority_valid;
00159 };
00160
00161
00165 struct _PurpleGroup {
00166 PurpleBlistNode node;
00167 char *name;
00168 int totalsize;
00169 int currentsize;
00170 int online;
00171 };
00172
00177 struct _PurpleChat {
00178 PurpleBlistNode node;
00179 char *alias;
00180 GHashTable *components;
00181 PurpleAccount *account;
00182 };
00183
00187 struct _PurpleBuddyList {
00188 PurpleBlistNode *root;
00189 GHashTable *buddies;
00190 void *ui_data;
00191 };
00192
00193 #endif
00194
00201 struct _PurpleBlistUiOps
00202 {
00203 void (*new_list)(PurpleBuddyList *list);
00204 void (*new_node)(PurpleBlistNode *node);
00205 void (*show)(PurpleBuddyList *list);
00206 void (*update)(PurpleBuddyList *list,
00207 PurpleBlistNode *node);
00208 void (*remove)(PurpleBuddyList *list,
00209 PurpleBlistNode *node);
00210 void (*destroy)(PurpleBuddyList *list);
00211 void (*set_visible)(PurpleBuddyList *list,
00212 gboolean show);
00213 void (*request_add_buddy)(PurpleAccount *account, const char *username,
00214 const char *group, const char *alias);
00215 void (*request_add_chat)(PurpleAccount *account, PurpleGroup *group,
00216 const char *alias, const char *name);
00217 void (*request_add_group)(void);
00218
00230 void (*save_node)(PurpleBlistNode *node);
00231
00244 void (*remove_node)(PurpleBlistNode *node);
00245
00259 void (*save_account)(PurpleAccount *account);
00260
00261 void (*_purple_reserved1)(void);
00262 };
00263
00264 #ifdef __cplusplus
00265 extern "C" {
00266 #endif
00267
00268
00270
00279 PurpleBuddyList *purple_blist_new(void);
00280
00287 void purple_set_blist(PurpleBuddyList *blist);
00288
00294 PurpleBuddyList *purple_get_blist(void);
00295
00301 PurpleBlistNode *purple_blist_get_root(void);
00302
00314 GSList *purple_blist_get_buddies(void);
00315
00323 gpointer purple_blist_get_ui_data(void);
00324
00332 void purple_blist_set_ui_data(gpointer ui_data);
00333
00346 PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
00347
00359 PurpleBlistNode *purple_blist_node_get_parent(PurpleBlistNode *node);
00360
00372 PurpleBlistNode *purple_blist_node_get_first_child(PurpleBlistNode *node);
00373
00385 PurpleBlistNode *purple_blist_node_get_sibling_next(PurpleBlistNode *node);
00386
00398 PurpleBlistNode *purple_blist_node_get_sibling_prev(PurpleBlistNode *node);
00399
00407 gpointer purple_blist_node_get_ui_data(const PurpleBlistNode *node);
00408
00417 void purple_blist_node_set_ui_data(PurpleBlistNode *node, gpointer ui_data);
00418
00422 void purple_blist_show(void);
00423
00424
00432 void purple_blist_destroy(void);
00433
00439 void purple_blist_set_visible(gboolean show);
00440
00449 void purple_blist_update_buddy_status(PurpleBuddy *buddy, PurpleStatus *old_status);
00450
00458 void purple_blist_update_node_icon(PurpleBlistNode *node);
00459
00460 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
00461
00467 void purple_blist_update_buddy_icon(PurpleBuddy *buddy);
00468 #endif
00469
00476 void purple_blist_rename_buddy(PurpleBuddy *buddy, const char *name);
00477
00484 void purple_blist_alias_contact(PurpleContact *contact, const char *alias);
00485
00492 void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias);
00493
00501 void purple_blist_server_alias_buddy(PurpleBuddy *buddy, const char *alias);
00502
00509 void purple_blist_alias_chat(PurpleChat *chat, const char *alias);
00510
00517 void purple_blist_rename_group(PurpleGroup *group, const char *name);
00518
00529 PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);
00530
00536 void purple_chat_destroy(PurpleChat *chat);
00537
00549 void purple_blist_add_chat(PurpleChat *chat, PurpleGroup *group, PurpleBlistNode *node);
00550
00566 PurpleBuddy *purple_buddy_new(PurpleAccount *account, const char *name, const char *alias);
00567
00573 void purple_buddy_destroy(PurpleBuddy *buddy);
00574
00586 void purple_buddy_set_icon(PurpleBuddy *buddy, PurpleBuddyIcon *icon);
00587
00595 PurpleAccount *purple_buddy_get_account(const PurpleBuddy *buddy);
00596
00604 const char *purple_buddy_get_name(const PurpleBuddy *buddy);
00605
00613 PurpleBuddyIcon *purple_buddy_get_icon(const PurpleBuddy *buddy);
00614
00626 gpointer purple_buddy_get_protocol_data(const PurpleBuddy *buddy);
00627
00639 void purple_buddy_set_protocol_data(PurpleBuddy *buddy, gpointer data);
00640
00648 PurpleContact *purple_buddy_get_contact(PurpleBuddy *buddy);
00649
00657 PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy);
00658
00672 void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
00673
00683 PurpleGroup *purple_group_new(const char *name);
00684
00690 void purple_group_destroy(PurpleGroup *group);
00691
00701 void purple_blist_add_group(PurpleGroup *group, PurpleBlistNode *node);
00702
00708 PurpleContact *purple_contact_new(void);
00709
00715 void purple_contact_destroy(PurpleContact *contact);
00716
00727 void purple_blist_add_contact(PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
00728
00737 void purple_blist_merge_contact(PurpleContact *source, PurpleBlistNode *node);
00738
00745 PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact);
00746
00747 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
00748
00756 void purple_contact_set_alias(PurpleContact *contact, const char *alias);
00757 #endif
00758
00765 const char *purple_contact_get_alias(PurpleContact *contact);
00766
00775 gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account);
00776
00783 void purple_contact_invalidate_priority_buddy(PurpleContact *contact);
00784
00793 void purple_blist_remove_buddy(PurpleBuddy *buddy);
00794
00804 void purple_blist_remove_contact(PurpleContact *contact);
00805
00811 void purple_blist_remove_chat(PurpleChat *chat);
00812
00819 void purple_blist_remove_group(PurpleGroup *group);
00820
00828 const char *purple_buddy_get_alias_only(PurpleBuddy *buddy);
00829
00836 const char *purple_buddy_get_server_alias(PurpleBuddy *buddy);
00837
00847 const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy);
00848
00849 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
00850
00859 const char *purple_buddy_get_local_alias(PurpleBuddy *buddy);
00860 #endif
00861
00870 const char *purple_buddy_get_alias(PurpleBuddy *buddy);
00871
00880 const char *purple_buddy_get_local_buddy_alias(PurpleBuddy *buddy);
00881
00888 const char *purple_chat_get_name(PurpleChat *chat);
00889
00897 PurpleBuddy *purple_find_buddy(PurpleAccount *account, const char *name);
00898
00907 PurpleBuddy *purple_find_buddy_in_group(PurpleAccount *account, const char *name,
00908 PurpleGroup *group);
00909
00918 GSList *purple_find_buddies(PurpleAccount *account, const char *name);
00919
00920
00927 PurpleGroup *purple_find_group(const char *name);
00928
00937 PurpleChat *purple_blist_find_chat(PurpleAccount *account, const char *name);
00938
00946 PurpleGroup *purple_chat_get_group(PurpleChat *chat);
00947
00957 PurpleAccount *purple_chat_get_account(PurpleChat *chat);
00958
00968 GHashTable *purple_chat_get_components(PurpleChat *chat);
00969
00976 PurpleGroup *purple_buddy_get_group(PurpleBuddy *buddy);
00977
00978
00987 GSList *purple_group_get_accounts(PurpleGroup *g);
00988
00997 gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account);
00998
01006 const char *purple_group_get_name(PurpleGroup *group);
01007
01014 void purple_blist_add_account(PurpleAccount *account);
01015
01016
01023 void purple_blist_remove_account(PurpleAccount *account);
01024
01025
01033 int purple_blist_get_group_size(PurpleGroup *group, gboolean offline);
01034
01041 int purple_blist_get_group_online_count(PurpleGroup *group);
01042
01045
01047
01048
01052 void purple_blist_load(void);
01053
01061 void purple_blist_schedule_save(void);
01062
01072 void purple_blist_request_add_buddy(PurpleAccount *account, const char *username,
01073 const char *group, const char *alias);
01074
01084 void purple_blist_request_add_chat(PurpleAccount *account, PurpleGroup *group,
01085 const char *alias, const char *name);
01086
01091 void purple_blist_request_add_group(void);
01092
01100 void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value);
01101
01110 gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key);
01111
01119 void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value);
01120
01129 int purple_blist_node_get_int(PurpleBlistNode *node, const char *key);
01130
01138 void purple_blist_node_set_string(PurpleBlistNode *node, const char *key,
01139 const char *value);
01140
01149 const char *purple_blist_node_get_string(PurpleBlistNode *node, const char *key);
01150
01157 void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key);
01158
01167 void purple_blist_node_set_flags(PurpleBlistNode *node, PurpleBlistNodeFlags flags);
01168
01176 PurpleBlistNodeFlags purple_blist_node_get_flags(PurpleBlistNode *node);
01177
01187 PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node);
01188
01197 GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n);
01198
01199
01201
01209 void purple_blist_set_ui_ops(PurpleBlistUiOps *ops);
01210
01216 PurpleBlistUiOps *purple_blist_get_ui_ops(void);
01217
01220
01222
01230 void *purple_blist_get_handle(void);
01231
01235 void purple_blist_init(void);
01236
01240 void purple_blist_uninit(void);
01241
01244 #ifdef __cplusplus
01245 }
01246 #endif
01247
01248 #endif