Mercurial > pidgin
diff libpurple/blist.h @ 15822:32c366eeeb99
sed -ie 's/gaim/purple/g'
| author | Sean Egan <seanegan@gmail.com> |
|---|---|
| date | Mon, 19 Mar 2007 07:01:17 +0000 |
| parents | 5fe8042783c1 |
| children | 516f14bef90e |
line wrap: on
line diff
--- a/libpurple/blist.h Mon Mar 19 06:11:46 2007 +0000 +++ b/libpurple/blist.h Mon Mar 19 07:01:17 2007 +0000 @@ -2,9 +2,9 @@ * @file blist.h Buddy List API * @ingroup core * - * gaim + * purple * - * Gaim is the legal property of its developers, whose names are too numerous + * Purple is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * @@ -22,55 +22,55 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -#ifndef _GAIM_BLIST_H_ -#define _GAIM_BLIST_H_ +#ifndef _PURPLE_BLIST_H_ +#define _PURPLE_BLIST_H_ /* I can't believe I let ChipX86 inspire me to write good code. -Sean */ #include <glib.h> -typedef struct _GaimBuddyList GaimBuddyList; -typedef struct _GaimBlistUiOps GaimBlistUiOps; -typedef struct _GaimBlistNode GaimBlistNode; +typedef struct _PurpleBuddyList PurpleBuddyList; +typedef struct _PurpleBlistUiOps PurpleBlistUiOps; +typedef struct _PurpleBlistNode PurpleBlistNode; -typedef struct _GaimChat GaimChat; -typedef struct _GaimGroup GaimGroup; -typedef struct _GaimContact GaimContact; -typedef struct _GaimBuddy GaimBuddy; +typedef struct _PurpleChat PurpleChat; +typedef struct _PurpleGroup PurpleGroup; +typedef struct _PurpleContact PurpleContact; +typedef struct _PurpleBuddy PurpleBuddy; /**************************************************************************/ /* Enumerations */ /**************************************************************************/ typedef enum { - GAIM_BLIST_GROUP_NODE, - GAIM_BLIST_CONTACT_NODE, - GAIM_BLIST_BUDDY_NODE, - GAIM_BLIST_CHAT_NODE, - GAIM_BLIST_OTHER_NODE + PURPLE_BLIST_GROUP_NODE, + PURPLE_BLIST_CONTACT_NODE, + PURPLE_BLIST_BUDDY_NODE, + PURPLE_BLIST_CHAT_NODE, + PURPLE_BLIST_OTHER_NODE -} GaimBlistNodeType; +} PurpleBlistNodeType; -#define GAIM_BLIST_NODE_IS_CHAT(n) ((n)->type == GAIM_BLIST_CHAT_NODE) -#define GAIM_BLIST_NODE_IS_BUDDY(n) ((n)->type == GAIM_BLIST_BUDDY_NODE) -#define GAIM_BLIST_NODE_IS_CONTACT(n) ((n)->type == GAIM_BLIST_CONTACT_NODE) -#define GAIM_BLIST_NODE_IS_GROUP(n) ((n)->type == GAIM_BLIST_GROUP_NODE) +#define PURPLE_BLIST_NODE_IS_CHAT(n) ((n)->type == PURPLE_BLIST_CHAT_NODE) +#define PURPLE_BLIST_NODE_IS_BUDDY(n) ((n)->type == PURPLE_BLIST_BUDDY_NODE) +#define PURPLE_BLIST_NODE_IS_CONTACT(n) ((n)->type == PURPLE_BLIST_CONTACT_NODE) +#define PURPLE_BLIST_NODE_IS_GROUP(n) ((n)->type == PURPLE_BLIST_GROUP_NODE) -#define GAIM_BUDDY_IS_ONLINE(b) \ - ((b) != NULL && gaim_account_is_connected((b)->account) && \ - gaim_presence_is_online(gaim_buddy_get_presence(b))) +#define PURPLE_BUDDY_IS_ONLINE(b) \ + ((b) != NULL && purple_account_is_connected((b)->account) && \ + purple_presence_is_online(purple_buddy_get_presence(b))) typedef enum { - GAIM_BLIST_NODE_FLAG_NO_SAVE = 1 /**< node should not be saved with the buddy list */ + PURPLE_BLIST_NODE_FLAG_NO_SAVE = 1 /**< node should not be saved with the buddy list */ -} GaimBlistNodeFlags; +} PurpleBlistNodeFlags; -#define GAIM_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f)) -#define GAIM_BLIST_NODE_SHOULD_SAVE(b) (! GAIM_BLIST_NODE_HAS_FLAG(b, GAIM_BLIST_NODE_FLAG_NO_SAVE)) +#define PURPLE_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f)) +#define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE)) -#define GAIM_BLIST_NODE_NAME(n) ((n)->type == GAIM_BLIST_CHAT_NODE ? gaim_chat_get_name((GaimChat*)n) : \ - (n)->type == GAIM_BLIST_BUDDY_NODE ? gaim_buddy_get_name((GaimBuddy*)n) : NULL) +#define PURPLE_BLIST_NODE_NAME(n) ((n)->type == PURPLE_BLIST_CHAT_NODE ? purple_chat_get_name((PurpleChat*)n) : \ + (n)->type == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL) #include "account.h" #include "buddyicon.h" @@ -84,50 +84,50 @@ * A Buddy list node. This can represent a group, a buddy, or anything else. * This is a base class for struct buddy and struct group and for anything * else that wants to put itself in the buddy list. */ -struct _GaimBlistNode { - GaimBlistNodeType type; /**< The type of node this is */ - GaimBlistNode *prev; /**< The sibling before this buddy. */ - GaimBlistNode *next; /**< The sibling after this buddy. */ - GaimBlistNode *parent; /**< The parent of this node */ - GaimBlistNode *child; /**< The child of this node */ +struct _PurpleBlistNode { + PurpleBlistNodeType type; /**< The type of node this is */ + PurpleBlistNode *prev; /**< The sibling before this buddy. */ + PurpleBlistNode *next; /**< The sibling after this buddy. */ + PurpleBlistNode *parent; /**< The parent of this node */ + PurpleBlistNode *child; /**< The child of this node */ GHashTable *settings; /**< per-node settings */ void *ui_data; /**< The UI can put data here. */ - GaimBlistNodeFlags flags; /**< The buddy flags */ + PurpleBlistNodeFlags flags; /**< The buddy flags */ }; /** - * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. + * A buddy. This contains everything Purple will ever need to know about someone on the buddy list. Everything. */ -struct _GaimBuddy { - GaimBlistNode node; /**< The node that this buddy inherits from */ +struct _PurpleBuddy { + PurpleBlistNode node; /**< The node that this buddy inherits from */ char *name; /**< The screenname of the buddy. */ char *alias; /**< The user-set alias of the buddy */ char *server_alias; /**< The server-specified alias of the buddy. (i.e. MSN "Friendly Names") */ void *proto_data; /**< This allows the prpl to associate whatever data it wants with a buddy */ - GaimBuddyIcon *icon; /**< The buddy icon. */ - GaimAccount *account; /**< the account this buddy belongs to */ - GaimPresence *presence; + PurpleBuddyIcon *icon; /**< The buddy icon. */ + PurpleAccount *account; /**< the account this buddy belongs to */ + PurplePresence *presence; }; /** - * A contact. This contains everything Gaim will ever need to know about a contact. + * A contact. This contains everything Purple will ever need to know about a contact. */ -struct _GaimContact { - GaimBlistNode node; /**< The node that this contact inherits from. */ +struct _PurpleContact { + PurpleBlistNode node; /**< The node that this contact inherits from. */ char *alias; /**< The user-set alias of the contact */ int totalsize; /**< The number of buddies in this contact */ int currentsize; /**< The number of buddies in this contact corresponding to online accounts */ int online; /**< The number of buddies in this contact who are currently online */ - GaimBuddy *priority; /**< The "top" buddy for this contact */ + PurpleBuddy *priority; /**< The "top" buddy for this contact */ gboolean priority_valid; /**< Is priority valid? */ }; /** - * A group. This contains everything Gaim will ever need to know about a group. + * A group. This contains everything Purple will ever need to know about a group. */ -struct _GaimGroup { - GaimBlistNode node; /**< The node that this group inherits from */ +struct _PurpleGroup { + PurpleBlistNode node; /**< The node that this group inherits from */ char *name; /**< The name of this group. */ int totalsize; /**< The number of chats and contacts in this group */ int currentsize; /**< The number of chats and contacts in this group corresponding to online accounts */ @@ -135,22 +135,22 @@ }; /** - * A chat. This contains everything Gaim needs to put a chat room in the + * A chat. This contains everything Purple needs to put a chat room in the * buddy list. */ -struct _GaimChat { - GaimBlistNode node; /**< The node that this chat inherits from */ +struct _PurpleChat { + PurpleBlistNode node; /**< The node that this chat inherits from */ char *alias; /**< The display name of this chat. */ GHashTable *components; /**< the stuff the protocol needs to know to join the chat */ - GaimAccount *account; /**< The account this chat is attached to */ + PurpleAccount *account; /**< The account this chat is attached to */ }; /** * The Buddy List */ -struct _GaimBuddyList { - GaimBlistNode *root; /**< The first node in the buddy list */ +struct _PurpleBuddyList { + PurpleBlistNode *root; /**< The first node in the buddy list */ GHashTable *buddies; /**< Every buddy in this list */ void *ui_data; /**< UI-specific data. */ }; @@ -158,24 +158,24 @@ /** * Buddy list UI operations. * - * Any UI representing a buddy list must assign a filled-out GaimBlistUiOps + * Any UI representing a buddy list must assign a filled-out PurpleBlistUiOps * structure to the buddy list core. */ -struct _GaimBlistUiOps +struct _PurpleBlistUiOps { - void (*new_list)(GaimBuddyList *list); /**< Sets UI-specific data on a buddy list. */ - void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */ - void (*show)(GaimBuddyList *list); /**< The core will call this when it's finished doing its core stuff */ - void (*update)(GaimBuddyList *list, - GaimBlistNode *node); /**< This will update a node in the buddy list. */ - void (*remove)(GaimBuddyList *list, - GaimBlistNode *node); /**< This removes a node from the list */ - void (*destroy)(GaimBuddyList *list); /**< When the list gets destroyed, this gets called to destroy the UI. */ - void (*set_visible)(GaimBuddyList *list, + void (*new_list)(PurpleBuddyList *list); /**< Sets UI-specific data on a buddy list. */ + void (*new_node)(PurpleBlistNode *node); /**< Sets UI-specific data on a node. */ + void (*show)(PurpleBuddyList *list); /**< The core will call this when it's finished doing its core stuff */ + void (*update)(PurpleBuddyList *list, + PurpleBlistNode *node); /**< This will update a node in the buddy list. */ + void (*remove)(PurpleBuddyList *list, + PurpleBlistNode *node); /**< This removes a node from the list */ + void (*destroy)(PurpleBuddyList *list); /**< When the list gets destroyed, this gets called to destroy the UI. */ + void (*set_visible)(PurpleBuddyList *list, gboolean show); /**< Hides or unhides the buddy list */ - void (*request_add_buddy)(GaimAccount *account, const char *username, + void (*request_add_buddy)(PurpleAccount *account, const char *username, const char *group, const char *alias); - void (*request_add_chat)(GaimAccount *account, GaimGroup *group, + void (*request_add_chat)(PurpleAccount *account, PurpleGroup *group, const char *alias, const char *name); void (*request_add_group)(void); }; @@ -194,56 +194,56 @@ * * @return The new buddy list. */ -GaimBuddyList *gaim_blist_new(void); +PurpleBuddyList *purple_blist_new(void); /** * Sets the main buddy list. * * @param blist The buddy list you want to use. */ -void gaim_set_blist(GaimBuddyList *blist); +void purple_set_blist(PurpleBuddyList *blist); /** * Returns the main buddy list. * * @return The main buddy list. */ -GaimBuddyList *gaim_get_blist(void); +PurpleBuddyList *purple_get_blist(void); /** * Returns the root node of the main buddy list. * * @return The root node. */ -GaimBlistNode *gaim_blist_get_root(void); +PurpleBlistNode *purple_blist_get_root(void); /** * Returns the next node of a given node. This function is to be used to iterate - * over the tree returned by gaim_get_blist. + * over the tree returned by purple_get_blist. * * @param node A node. * @param offline Whether to include nodes for offline accounts * @return The next node */ -GaimBlistNode *gaim_blist_node_next(GaimBlistNode *node, gboolean offline); +PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline); /** * Shows the buddy list, creating a new one if necessary. */ -void gaim_blist_show(void); +void purple_blist_show(void); /** * Destroys the buddy list window. */ -void gaim_blist_destroy(void); +void purple_blist_destroy(void); /** * Hides or unhides the buddy list. * * @param show Whether or not to show the buddy list */ -void gaim_blist_set_visible(gboolean show); +void purple_blist_set_visible(gboolean show); /** * Updates a buddy's status. @@ -251,14 +251,14 @@ * @param buddy The buddy whose status has changed. * @param old_status The status from which we are changing. */ -void gaim_blist_update_buddy_status(GaimBuddy *buddy, GaimStatus *old_status); +void purple_blist_update_buddy_status(PurpleBuddy *buddy, PurpleStatus *old_status); /** * Updates a buddy's icon. * * @param buddy The buddy whose buddy icon has changed */ -void gaim_blist_update_buddy_icon(GaimBuddy *buddy); +void purple_blist_update_buddy_icon(PurpleBuddy *buddy); /** * Renames a buddy in the buddy list. @@ -266,7 +266,7 @@ * @param buddy The buddy whose name will be changed. * @param name The new name of the buddy. */ -void gaim_blist_rename_buddy(GaimBuddy *buddy, const char *name); +void purple_blist_rename_buddy(PurpleBuddy *buddy, const char *name); /** * Aliases a contact in the buddy list. @@ -274,7 +274,7 @@ * @param contact The contact whose alias will be changed. * @param alias The contact's alias. */ -void gaim_blist_alias_contact(GaimContact *contact, const char *alias); +void purple_blist_alias_contact(PurpleContact *contact, const char *alias); /** * Aliases a buddy in the buddy list. @@ -282,7 +282,7 @@ * @param buddy The buddy whose alias will be changed. * @param alias The buddy's alias. */ -void gaim_blist_alias_buddy(GaimBuddy *buddy, const char *alias); +void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias); /** * Sets the server-sent alias of a buddy in the buddy list. @@ -291,7 +291,7 @@ * @param buddy The buddy whose alias will be changed. * @param alias The buddy's "official" alias. */ -void gaim_blist_server_alias_buddy(GaimBuddy *buddy, const char *alias); +void purple_blist_server_alias_buddy(PurpleBuddy *buddy, const char *alias); /** * Aliases a chat in the buddy list. @@ -299,7 +299,7 @@ * @param chat The chat whose alias will be changed. * @param alias The chat's new alias. */ -void gaim_blist_alias_chat(GaimChat *chat, const char *alias); +void purple_blist_alias_chat(PurpleChat *chat, const char *alias); /** * Renames a group @@ -307,7 +307,7 @@ * @param group The group to rename * @param name The new name */ -void gaim_blist_rename_group(GaimGroup *group, const char *name); +void purple_blist_rename_group(PurpleGroup *group, const char *name); /** * Creates a new chat for the buddy list @@ -319,7 +319,7 @@ * equal function should be g_str_equal(). * @return A newly allocated chat */ -GaimChat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components); +PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components); /** * Adds a new chat to the buddy list. @@ -332,7 +332,7 @@ * @param group The group to add the new chat to. * @param node The insertion point */ -void gaim_blist_add_chat(GaimChat *chat, GaimGroup *group, GaimBlistNode *node); +void purple_blist_add_chat(PurpleChat *chat, PurpleGroup *group, PurpleBlistNode *node); /** * Creates a new buddy @@ -342,20 +342,20 @@ * @param alias The alias of the new buddy (or NULL if unaliased) * @return A newly allocated buddy */ -GaimBuddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); +PurpleBuddy *purple_buddy_new(PurpleAccount *account, const char *screenname, const char *alias); /** * Sets a buddy's icon. * - * This should only be called from within Gaim. You probably want to - * call gaim_buddy_icon_set_data(). + * This should only be called from within Purple. You probably want to + * call purple_buddy_icon_set_data(). * * @param buddy The buddy. * @param icon The buddy icon. * - * @see gaim_buddy_icon_set_data() + * @see purple_buddy_icon_set_data() */ -void gaim_buddy_set_icon(GaimBuddy *buddy, GaimBuddyIcon *icon); +void purple_buddy_set_icon(PurpleBuddy *buddy, PurpleBuddyIcon *icon); /** * Returns a buddy's account. @@ -364,7 +364,7 @@ * * @return The account */ -GaimAccount *gaim_buddy_get_account(const GaimBuddy *buddy); +PurpleAccount *purple_buddy_get_account(const PurpleBuddy *buddy); /** * Returns a buddy's name @@ -373,7 +373,7 @@ * * @return The name. */ -const char *gaim_buddy_get_name(const GaimBuddy *buddy); +const char *purple_buddy_get_name(const PurpleBuddy *buddy); /** * Returns a buddy's icon. @@ -382,7 +382,7 @@ * * @return The buddy icon. */ -GaimBuddyIcon *gaim_buddy_get_icon(const GaimBuddy *buddy); +PurpleBuddyIcon *purple_buddy_get_icon(const PurpleBuddy *buddy); /** * Returns a buddy's contact. @@ -391,7 +391,7 @@ * * @return The buddy's contact. */ -GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy); +PurpleContact *purple_buddy_get_contact(PurpleBuddy *buddy); /** * Returns a buddy's presence. @@ -400,7 +400,7 @@ * * @return The buddy's presence. */ -GaimPresence *gaim_buddy_get_presence(const GaimBuddy *buddy); +PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy); /** * Adds a new buddy to the buddy list. @@ -414,7 +414,7 @@ * @param group The group to add the new buddy to. * @param node The insertion point */ -void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); +void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node); /** * Creates a new group @@ -425,7 +425,7 @@ * @param name The name of the new group * @return A new group struct */ -GaimGroup *gaim_group_new(const char *name); +PurpleGroup *purple_group_new(const char *name); /** * Adds a new group to the buddy list. @@ -436,14 +436,14 @@ * @param group The group * @param node The insertion point */ -void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); +void purple_blist_add_group(PurpleGroup *group, PurpleBlistNode *node); /** * Creates a new contact * * @return A new contact struct */ -GaimContact *gaim_contact_new(void); +PurpleContact *purple_contact_new(void); /** * Adds a new contact to the buddy list. @@ -455,7 +455,7 @@ * @param group The group to add the contact to * @param node The insertion point */ -void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); +void purple_blist_add_contact(PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node); /** * Merges two contacts @@ -465,7 +465,7 @@ * @param source The contact to merge * @param node The place to merge to (a buddy or contact) */ -void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node); +void purple_blist_merge_contact(PurpleContact *source, PurpleBlistNode *node); /** * Returns the highest priority buddy for a given contact. @@ -473,7 +473,7 @@ * @param contact The contact * @return The highest priority buddy */ -GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); +PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact); /** * Sets the alias for a contact. @@ -481,7 +481,7 @@ * @param contact The contact * @param alias The alias to set, or NULL to unset */ -void gaim_contact_set_alias(GaimContact *contact, const char *alias); +void purple_contact_set_alias(PurpleContact *contact, const char *alias); /** * Gets the alias for a contact. @@ -489,7 +489,7 @@ * @param contact The contact * @return The alias, or NULL if it is not set. */ -const char *gaim_contact_get_alias(GaimContact *contact); +const char *purple_contact_get_alias(PurpleContact *contact); /** * Determines whether an account owns any buddies in a given contact @@ -499,21 +499,21 @@ * * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise. */ -gboolean gaim_contact_on_account(GaimContact *contact, GaimAccount *account); +gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account); /** * Invalidates the priority buddy so that the next call to - * gaim_contact_get_priority_buddy recomputes it. + * purple_contact_get_priority_buddy recomputes it. * * @param contact The contact */ -void gaim_contact_invalidate_priority_buddy(GaimContact *contact); +void purple_contact_invalidate_priority_buddy(PurpleContact *contact); /** * Removes a buddy from the buddy list and frees the memory allocated to it. * * @param buddy The buddy to be removed */ -void gaim_blist_remove_buddy(GaimBuddy *buddy); +void purple_blist_remove_buddy(PurpleBuddy *buddy); /** * Removes a contact, and any buddies it contains, and frees the memory @@ -521,14 +521,14 @@ * * @param contact The contact to be removed */ -void gaim_blist_remove_contact(GaimContact *contact); +void purple_blist_remove_contact(PurpleContact *contact); /** * Removes a chat from the buddy list and frees the memory allocated to it. * * @param chat The chat to be removed */ -void gaim_blist_remove_chat(GaimChat *chat); +void purple_blist_remove_chat(PurpleChat *chat); /** * Removes a group from the buddy list and frees the memory allocated to it and to @@ -536,7 +536,7 @@ * * @param group The group to be removed */ -void gaim_blist_remove_group(GaimGroup *group); +void purple_blist_remove_group(PurpleGroup *group); /** * Returns the alias of a buddy. @@ -545,7 +545,7 @@ * @return The alias (if set), server alias (if set), * or NULL. */ -const char *gaim_buddy_get_alias_only(GaimBuddy *buddy); +const char *purple_buddy_get_alias_only(PurpleBuddy *buddy); /** * Gets the server alias for a buddy. @@ -553,7 +553,7 @@ * @param buddy The buddy whose name will be returned * @return The server alias, or NULL if it is not set. */ -const char *gaim_buddy_get_server_alias(GaimBuddy *buddy); +const char *purple_buddy_get_server_alias(PurpleBuddy *buddy); /** * Returns the correct name to display for a buddy, taking the contact alias @@ -564,7 +564,7 @@ * @return The appropriate name or alias, or NULL. * */ -const char *gaim_buddy_get_contact_alias(GaimBuddy *buddy); +const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy); /** * Returns the correct alias for this user, ignoring server aliases. Used @@ -574,7 +574,7 @@ * @param buddy The buddy whose alias will be returned. * @return The appropriate name or alias. */ -const char *gaim_buddy_get_local_alias(GaimBuddy *buddy); +const char *purple_buddy_get_local_alias(PurpleBuddy *buddy); /** * Returns the correct name to display for a buddy. In order of precedence: @@ -584,7 +584,7 @@ * @param buddy The buddy whose name will be returned. * @return The appropriate name or alias, or NULL */ -const char *gaim_buddy_get_alias(GaimBuddy *buddy); +const char *purple_buddy_get_alias(PurpleBuddy *buddy); /** * Returns the correct name to display for a blist chat. @@ -592,7 +592,7 @@ * @param chat The chat whose name will be returned. * @return The alias (if set), or first component value. */ -const char *gaim_chat_get_name(GaimChat *chat); +const char *purple_chat_get_name(PurpleChat *chat); /** * Finds the buddy struct given a screenname and an account @@ -601,7 +601,7 @@ * @param name The buddy's screenname * @return The buddy or NULL if the buddy does not exist */ -GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); +PurpleBuddy *purple_find_buddy(PurpleAccount *account, const char *name); /** * Finds the buddy struct given a screenname, an account, and a group @@ -611,18 +611,18 @@ * @param group The group to look in * @return The buddy or NULL if the buddy does not exist in the group */ -GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name, - GaimGroup *group); +PurpleBuddy *purple_find_buddy_in_group(PurpleAccount *account, const char *name, + PurpleGroup *group); /** - * Finds all GaimBuddy structs given a screenname and an account + * Finds all PurpleBuddy structs given a screenname and an account * * @param account The account this buddy belongs to * @param name The buddy's screenname (or NULL to return all buddies in the account) * * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist */ -GSList *gaim_find_buddies(GaimAccount *account, const char *name); +GSList *purple_find_buddies(PurpleAccount *account, const char *name); /** @@ -631,7 +631,7 @@ * @param name The groups name * @return The group or NULL if the group does not exist */ -GaimGroup *gaim_find_group(const char *name); +PurpleGroup *purple_find_group(const char *name); /** * Finds a chat by name. @@ -641,7 +641,7 @@ * * @return The chat, or @c NULL if the chat does not exist. */ -GaimChat *gaim_blist_find_chat(GaimAccount *account, const char *name); +PurpleChat *purple_blist_find_chat(PurpleAccount *account, const char *name); /** * Returns the group of which the chat is a member. @@ -650,7 +650,7 @@ * * @return The parent group, or @c NULL if the chat is not in a group. */ -GaimGroup *gaim_chat_get_group(GaimChat *chat); +PurpleGroup *purple_chat_get_group(PurpleChat *chat); /** * Returns the group of which the buddy is a member. @@ -658,7 +658,7 @@ * @param buddy The buddy * @return The group or NULL if the buddy is not in a group */ -GaimGroup *gaim_buddy_get_group(GaimBuddy *buddy); +PurpleGroup *purple_buddy_get_group(PurpleBuddy *buddy); /** @@ -666,9 +666,9 @@ * * @param g The group * - * @return A list of gaim_accounts + * @return A list of purple_accounts */ -GSList *gaim_group_get_accounts(GaimGroup *g); +GSList *purple_group_get_accounts(PurpleGroup *g); /** * Determines whether an account owns any buddies in a given group @@ -678,7 +678,7 @@ * * @return TRUE if there are any buddies in the group, or FALSE otherwise. */ -gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); +gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account); /** * Called when an account gets signed on. Tells the UI to update all the @@ -686,7 +686,7 @@ * * @param account The account */ -void gaim_blist_add_account(GaimAccount *account); +void purple_blist_add_account(PurpleAccount *account); /** @@ -695,7 +695,7 @@ * * @param account The account */ -void gaim_blist_remove_account(GaimAccount *account); +void purple_blist_remove_account(PurpleAccount *account); /** @@ -705,7 +705,7 @@ * @param offline Count buddies in offline accounts * @return The number of buddies in the group */ -int gaim_blist_get_group_size(GaimGroup *group, gboolean offline); +int purple_blist_get_group_size(PurpleGroup *group, gboolean offline); /** * Determines the number of online buddies in a group @@ -713,7 +713,7 @@ * @param group The group * @return The number of online buddies in the group, or 0 if the group is NULL */ -int gaim_blist_get_group_online_count(GaimGroup *group); +int purple_blist_get_group_online_count(PurpleGroup *group); /*@}*/ @@ -722,9 +722,9 @@ /****************************************************************************************/ /** - * Loads the buddy list from ~/.gaim/blist.xml. + * Loads the buddy list from ~/.purple/blist.xml. */ -void gaim_blist_load(void); +void purple_blist_load(void); /** * Schedule a save of the blist.xml file. This is used by the privacy @@ -733,7 +733,7 @@ * the buddy list is saved automatically, so you should not need to * call this. */ -void gaim_blist_schedule_save(void); +void purple_blist_schedule_save(void); /** * Requests from the user information needed to add a buddy to the @@ -744,7 +744,7 @@ * @param group The name of the group to place the buddy in. * @param alias The optional alias for the buddy. */ -void gaim_blist_request_add_buddy(GaimAccount *account, const char *username, +void purple_blist_request_add_buddy(PurpleAccount *account, const char *username, const char *group, const char *alias); /** @@ -756,14 +756,14 @@ * @param alias The optional alias for the chat. * @param name The required chat name. */ -void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group, +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 group to the * buddy list. */ -void gaim_blist_request_add_group(void); +void purple_blist_request_add_group(void); /** * Associates a boolean with a node in the buddy list @@ -772,7 +772,7 @@ * @param key The identifier for the data * @param value The value to set */ -void gaim_blist_node_set_bool(GaimBlistNode *node, const char *key, gboolean value); +void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value); /** * Retrieves a named boolean setting from a node in the buddy list @@ -782,7 +782,7 @@ * * @return The value, or FALSE if there is no setting */ -gboolean gaim_blist_node_get_bool(GaimBlistNode *node, const char *key); +gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key); /** * Associates an integer with a node in the buddy list @@ -791,7 +791,7 @@ * @param key The identifier for the data * @param value The value to set */ -void gaim_blist_node_set_int(GaimBlistNode *node, const char *key, int value); +void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value); /** * Retrieves a named integer setting from a node in the buddy list @@ -801,7 +801,7 @@ * * @return The value, or 0 if there is no setting */ -int gaim_blist_node_get_int(GaimBlistNode *node, const char *key); +int purple_blist_node_get_int(PurpleBlistNode *node, const char *key); /** * Associates a string with a node in the buddy list @@ -810,7 +810,7 @@ * @param key The identifier for the data * @param value The value to set */ -void gaim_blist_node_set_string(GaimBlistNode *node, const char *key, +void purple_blist_node_set_string(PurpleBlistNode *node, const char *key, const char *value); /** @@ -821,7 +821,7 @@ * * @return The value, or NULL if there is no setting */ -const char *gaim_blist_node_get_string(GaimBlistNode *node, const char *key); +const char *purple_blist_node_get_string(PurpleBlistNode *node, const char *key); /** * Removes a named setting from a blist node @@ -829,17 +829,17 @@ * @param node The node from which to remove the setting * @param key The name of the setting */ -void gaim_blist_node_remove_setting(GaimBlistNode *node, const char *key); +void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key); /** * Set the flags for the given node. Setting a node's flags will overwrite * the old flags, so if you want to save them, you must first call - * gaim_blist_node_get_flags and modify that appropriately. + * purple_blist_node_get_flags and modify that appropriately. * * @param node The node on which to set the flags. * @param flags The flags to set. This is a bitmask. */ -void gaim_blist_node_set_flags(GaimBlistNode *node, GaimBlistNodeFlags flags); +void purple_blist_node_set_flags(PurpleBlistNode *node, PurpleBlistNodeFlags flags); /** * Get the current flags on a given node. @@ -848,17 +848,17 @@ * * @return The flags on the node. This is a bitmask. */ -GaimBlistNodeFlags gaim_blist_node_get_flags(GaimBlistNode *node); +PurpleBlistNodeFlags purple_blist_node_get_flags(PurpleBlistNode *node); /*@}*/ /** * Retrieves the extended menu items for a buddy list node. * @param n The blist node for which to obtain the extended menu items. - * @return A list of GaimMenuAction items, as harvested by the + * @return A list of PurpleMenuAction items, as harvested by the * blist-node-extended-menu signal. */ -GList *gaim_blist_node_get_extended_menu(GaimBlistNode *n); +GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n); /**************************************************************************/ /** @name UI Registration Functions */ @@ -870,14 +870,14 @@ * * @param ops The ops struct. */ -void gaim_blist_set_ui_ops(GaimBlistUiOps *ops); +void purple_blist_set_ui_ops(PurpleBlistUiOps *ops); /** * Returns the UI operations structure to be used for the buddy list. * * @return The UI operations structure. */ -GaimBlistUiOps *gaim_blist_get_ui_ops(void); +PurpleBlistUiOps *purple_blist_get_ui_ops(void); /*@}*/ @@ -891,17 +891,17 @@ * * @return The buddy list subsystem handle. */ -void *gaim_blist_get_handle(void); +void *purple_blist_get_handle(void); /** * Initializes the buddy list subsystem. */ -void gaim_blist_init(void); +void purple_blist_init(void); /** * Uninitializes the buddy list subsystem. */ -void gaim_blist_uninit(void); +void purple_blist_uninit(void); /*@}*/ @@ -909,4 +909,4 @@ } #endif -#endif /* _GAIM_BLIST_H_ */ +#endif /* _PURPLE_BLIST_H_ */
