00001
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028 #ifndef _PURPLE_BLIST_H_
00029 #define _PURPLE_BLIST_H_
00030
00031
00032
00033 #include <glib.h>
00034
00035 typedef struct _PurpleBuddyList PurpleBuddyList;
00036 typedef struct _PurpleBlistUiOps PurpleBlistUiOps;
00037 typedef struct _PurpleBlistNode PurpleBlistNode;
00038
00039 typedef struct _PurpleChat PurpleChat;
00040 typedef struct _PurpleGroup PurpleGroup;
00041 typedef struct _PurpleContact PurpleContact;
00042 typedef struct _PurpleBuddy PurpleBuddy;
00043
00044
00045
00046
00047 typedef enum
00048 {
00049 PURPLE_BLIST_GROUP_NODE,
00050 PURPLE_BLIST_CONTACT_NODE,
00051 PURPLE_BLIST_BUDDY_NODE,
00052 PURPLE_BLIST_CHAT_NODE,
00053 PURPLE_BLIST_OTHER_NODE
00054
00055 } PurpleBlistNodeType;
00056
00057 #define PURPLE_BLIST_NODE_IS_CHAT(n) ((n)->type == PURPLE_BLIST_CHAT_NODE)
00058 #define PURPLE_BLIST_NODE_IS_BUDDY(n) ((n)->type == PURPLE_BLIST_BUDDY_NODE)
00059 #define PURPLE_BLIST_NODE_IS_CONTACT(n) ((n)->type == PURPLE_BLIST_CONTACT_NODE)
00060 #define PURPLE_BLIST_NODE_IS_GROUP(n) ((n)->type == PURPLE_BLIST_GROUP_NODE)
00061
00062 #define PURPLE_BUDDY_IS_ONLINE(b) \
00063 ((b) != NULL && purple_account_is_connected((b)->account) && \
00064 purple_presence_is_online(purple_buddy_get_presence(b)))
00065
00066 typedef enum
00067 {
00068 PURPLE_BLIST_NODE_FLAG_NO_SAVE = 1
00070 } PurpleBlistNodeFlags;
00071
00072 #define PURPLE_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f))
00073 #define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE))
00074
00075 #define PURPLE_BLIST_NODE_NAME(n) ((n)->type == PURPLE_BLIST_CHAT_NODE ? purple_chat_get_name((PurpleChat*)n) : \
00076 (n)->type == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL)
00077
00078 #include "account.h"
00079 #include "buddyicon.h"
00080 #include "status.h"
00081
00082
00083
00084
00085
00090 struct _PurpleBlistNode {
00091 PurpleBlistNodeType type;
00092 PurpleBlistNode *prev;
00093 PurpleBlistNode *next;
00094 PurpleBlistNode *parent;
00095 PurpleBlistNode *child;
00096 GHashTable *settings;
00097 void *ui_data;
00098 PurpleBlistNodeFlags flags;
00099 };
00100
00104 struct _PurpleBuddy {
00105 PurpleBlistNode node;
00106 char *name;
00107 char *alias;
00108 char *server_alias;
00109 void *proto_data;
00110 PurpleBuddyIcon *icon;
00111 PurpleAccount *account;
00112 PurplePresence *presence;
00113 };
00114
00118 struct _PurpleContact {
00119 PurpleBlistNode node;
00120 char *alias;
00121 int totalsize;
00122 int currentsize;
00123 int online;
00124 PurpleBuddy *priority;
00125 gboolean priority_valid;
00126 };
00127
00128
00132 struct _PurpleGroup {
00133 PurpleBlistNode node;
00134 char *name;
00135 int totalsize;
00136 int currentsize;
00137 int online;
00138 };
00139
00144 struct _PurpleChat {
00145 PurpleBlistNode node;
00146 char *alias;
00147 GHashTable *components;
00148 PurpleAccount *account;
00149 };
00150
00151
00155 struct _PurpleBuddyList {
00156 PurpleBlistNode *root;
00157 GHashTable *buddies;
00158 void *ui_data;
00159 };
00160
00167 struct _PurpleBlistUiOps
00168 {
00169 void (*new_list)(PurpleBuddyList *list);
00170 void (*new_node)(PurpleBlistNode *node);
00171 void (*show)(PurpleBuddyList *list);
00172 void (*update)(PurpleBuddyList *list,
00173 PurpleBlistNode *node);
00174 void (*remove)(PurpleBuddyList *list,
00175 PurpleBlistNode *node);
00176 void (*destroy)(PurpleBuddyList *list);
00177 void (*set_visible)(PurpleBuddyList *list,
00178 gboolean show);
00179 void (*request_add_buddy)(PurpleAccount *account, const char *username,
00180 const char *group, const char *alias);
00181 void (*request_add_chat)(PurpleAccount *account, PurpleGroup *group,
00182 const char *alias, const char *name);
00183 void (*request_add_group)(void);
00184
00185 void (*_purple_reserved1)(void);
00186 void (*_purple_reserved2)(void);
00187 void (*_purple_reserved3)(void);
00188 void (*_purple_reserved4)(void);
00189 };
00190
00191 #ifdef __cplusplus
00192 extern "C" {
00193 #endif
00194
00195
00197
00205 PurpleBuddyList *purple_blist_new(void);
00206
00212 void purple_set_blist(PurpleBuddyList *blist);
00213
00219 PurpleBuddyList *purple_get_blist(void);
00220
00226 PurpleBlistNode *purple_blist_get_root(void);
00227
00236 PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
00237
00241 void purple_blist_show(void);
00242
00243
00247 void purple_blist_destroy(void);
00248
00254 void purple_blist_set_visible(gboolean show);
00255
00262 void purple_blist_update_buddy_status(PurpleBuddy *buddy, PurpleStatus *old_status);
00263
00269 void purple_blist_update_buddy_icon(PurpleBuddy *buddy);
00270
00277 void purple_blist_rename_buddy(PurpleBuddy *buddy, const char *name);
00278
00285 void purple_blist_alias_contact(PurpleContact *contact, const char *alias);
00286
00293 void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias);
00294
00302 void purple_blist_server_alias_buddy(PurpleBuddy *buddy, const char *alias);
00303
00310 void purple_blist_alias_chat(PurpleChat *chat, const char *alias);
00311
00318 void purple_blist_rename_group(PurpleGroup *group, const char *name);
00319
00330 PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);
00331
00343 void purple_blist_add_chat(PurpleChat *chat, PurpleGroup *group, PurpleBlistNode *node);
00344
00353 PurpleBuddy *purple_buddy_new(PurpleAccount *account, const char *screenname, const char *alias);
00354
00366 void purple_buddy_set_icon(PurpleBuddy *buddy, PurpleBuddyIcon *icon);
00367
00375 PurpleAccount *purple_buddy_get_account(const PurpleBuddy *buddy);
00376
00384 const char *purple_buddy_get_name(const PurpleBuddy *buddy);
00385
00393 PurpleBuddyIcon *purple_buddy_get_icon(const PurpleBuddy *buddy);
00394
00402 PurpleContact *purple_buddy_get_contact(PurpleBuddy *buddy);
00403
00411 PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy);
00412
00425 void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
00426
00436 PurpleGroup *purple_group_new(const char *name);
00437
00447 void purple_blist_add_group(PurpleGroup *group, PurpleBlistNode *node);
00448
00454 PurpleContact *purple_contact_new(void);
00455
00466 void purple_blist_add_contact(PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
00467
00476 void purple_blist_merge_contact(PurpleContact *source, PurpleBlistNode *node);
00477
00484 PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact);
00485
00492 void purple_contact_set_alias(PurpleContact *contact, const char *alias);
00493
00500 const char *purple_contact_get_alias(PurpleContact *contact);
00501
00510 gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account);
00511
00518 void purple_contact_invalidate_priority_buddy(PurpleContact *contact);
00524 void purple_blist_remove_buddy(PurpleBuddy *buddy);
00525
00532 void purple_blist_remove_contact(PurpleContact *contact);
00533
00539 void purple_blist_remove_chat(PurpleChat *chat);
00540
00547 void purple_blist_remove_group(PurpleGroup *group);
00548
00556 const char *purple_buddy_get_alias_only(PurpleBuddy *buddy);
00557
00564 const char *purple_buddy_get_server_alias(PurpleBuddy *buddy);
00565
00575 const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy);
00576
00585 const char *purple_buddy_get_local_alias(PurpleBuddy *buddy);
00586
00595 const char *purple_buddy_get_alias(PurpleBuddy *buddy);
00596
00603 const char *purple_chat_get_name(PurpleChat *chat);
00604
00612 PurpleBuddy *purple_find_buddy(PurpleAccount *account, const char *name);
00613
00622 PurpleBuddy *purple_find_buddy_in_group(PurpleAccount *account, const char *name,
00623 PurpleGroup *group);
00624
00633 GSList *purple_find_buddies(PurpleAccount *account, const char *name);
00634
00635
00642 PurpleGroup *purple_find_group(const char *name);
00643
00652 PurpleChat *purple_blist_find_chat(PurpleAccount *account, const char *name);
00653
00661 PurpleGroup *purple_chat_get_group(PurpleChat *chat);
00662
00669 PurpleGroup *purple_buddy_get_group(PurpleBuddy *buddy);
00670
00671
00679 GSList *purple_group_get_accounts(PurpleGroup *g);
00680
00689 gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account);
00690
00698 const char *purple_group_get_name(PurpleGroup *group);
00699
00706 void purple_blist_add_account(PurpleAccount *account);
00707
00708
00715 void purple_blist_remove_account(PurpleAccount *account);
00716
00717
00725 int purple_blist_get_group_size(PurpleGroup *group, gboolean offline);
00726
00733 int purple_blist_get_group_online_count(PurpleGroup *group);
00734
00737
00739
00740
00744 void purple_blist_load(void);
00745
00753 void purple_blist_schedule_save(void);
00754
00764 void purple_blist_request_add_buddy(PurpleAccount *account, const char *username,
00765 const char *group, const char *alias);
00766
00776 void purple_blist_request_add_chat(PurpleAccount *account, PurpleGroup *group,
00777 const char *alias, const char *name);
00778
00783 void purple_blist_request_add_group(void);
00784
00792 void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value);
00793
00802 gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key);
00803
00811 void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value);
00812
00821 int purple_blist_node_get_int(PurpleBlistNode *node, const char *key);
00822
00830 void purple_blist_node_set_string(PurpleBlistNode *node, const char *key,
00831 const char *value);
00832
00841 const char *purple_blist_node_get_string(PurpleBlistNode *node, const char *key);
00842
00849 void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key);
00850
00859 void purple_blist_node_set_flags(PurpleBlistNode *node, PurpleBlistNodeFlags flags);
00860
00868 PurpleBlistNodeFlags purple_blist_node_get_flags(PurpleBlistNode *node);
00869
00877 PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node);
00878
00887 GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n);
00888
00889
00891
00899 void purple_blist_set_ui_ops(PurpleBlistUiOps *ops);
00900
00906 PurpleBlistUiOps *purple_blist_get_ui_ops(void);
00907
00910
00912
00920 void *purple_blist_get_handle(void);
00921
00925 void purple_blist_init(void);
00926
00930 void purple_blist_uninit(void);
00931
00934 #ifdef __cplusplus
00935 }
00936 #endif
00937
00938 #endif