Mercurial > pidgin.yaz
diff libpurple/conversation.h @ 15823: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 | e058328dc954 |
line wrap: on
line diff
--- a/libpurple/conversation.h Mon Mar 19 06:11:46 2007 +0000 +++ b/libpurple/conversation.h Mon Mar 19 07:01:17 2007 +0000 @@ -2,9 +2,9 @@ * @file conversation.h Conversation 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. * @@ -24,114 +24,114 @@ * * @see @ref conversation-signals */ -#ifndef _GAIM_CONVERSATION_H_ -#define _GAIM_CONVERSATION_H_ +#ifndef _PURPLE_CONVERSATION_H_ +#define _PURPLE_CONVERSATION_H_ /**************************************************************************/ /** Data Structures */ /**************************************************************************/ -typedef struct _GaimConversationUiOps GaimConversationUiOps; -typedef struct _GaimConversation GaimConversation; -typedef struct _GaimConvIm GaimConvIm; -typedef struct _GaimConvChat GaimConvChat; -typedef struct _GaimConvChatBuddy GaimConvChatBuddy; +typedef struct _PurpleConversationUiOps PurpleConversationUiOps; +typedef struct _PurpleConversation PurpleConversation; +typedef struct _PurpleConvIm PurpleConvIm; +typedef struct _PurpleConvChat PurpleConvChat; +typedef struct _PurpleConvChatBuddy PurpleConvChatBuddy; /** * A type of conversation. */ typedef enum { - GAIM_CONV_TYPE_UNKNOWN = 0, /**< Unknown conversation type. */ - GAIM_CONV_TYPE_IM, /**< Instant Message. */ - GAIM_CONV_TYPE_CHAT, /**< Chat room. */ - GAIM_CONV_TYPE_MISC, /**< A misc. conversation. */ - GAIM_CONV_TYPE_ANY /**< Any type of conversation. */ + PURPLE_CONV_TYPE_UNKNOWN = 0, /**< Unknown conversation type. */ + PURPLE_CONV_TYPE_IM, /**< Instant Message. */ + PURPLE_CONV_TYPE_CHAT, /**< Chat room. */ + PURPLE_CONV_TYPE_MISC, /**< A misc. conversation. */ + PURPLE_CONV_TYPE_ANY /**< Any type of conversation. */ -} GaimConversationType; +} PurpleConversationType; /** * Conversation update type. */ typedef enum { - GAIM_CONV_UPDATE_ADD = 0, /**< The buddy associated with the conversation + PURPLE_CONV_UPDATE_ADD = 0, /**< The buddy associated with the conversation was added. */ - GAIM_CONV_UPDATE_REMOVE, /**< The buddy associated with the conversation + PURPLE_CONV_UPDATE_REMOVE, /**< The buddy associated with the conversation was removed. */ - GAIM_CONV_UPDATE_ACCOUNT, /**< The gaim_account was changed. */ - GAIM_CONV_UPDATE_TYPING, /**< The typing state was updated. */ - GAIM_CONV_UPDATE_UNSEEN, /**< The unseen state was updated. */ - GAIM_CONV_UPDATE_LOGGING, /**< Logging for this conversation was + PURPLE_CONV_UPDATE_ACCOUNT, /**< The purple_account was changed. */ + PURPLE_CONV_UPDATE_TYPING, /**< The typing state was updated. */ + PURPLE_CONV_UPDATE_UNSEEN, /**< The unseen state was updated. */ + PURPLE_CONV_UPDATE_LOGGING, /**< Logging for this conversation was enabled or disabled. */ - GAIM_CONV_UPDATE_TOPIC, /**< The topic for a chat was updated. */ + PURPLE_CONV_UPDATE_TOPIC, /**< The topic for a chat was updated. */ /* * XXX These need to go when we implement a more generic core/UI event * system. */ - GAIM_CONV_ACCOUNT_ONLINE, /**< One of the user's accounts went online. */ - GAIM_CONV_ACCOUNT_OFFLINE, /**< One of the user's accounts went offline. */ - GAIM_CONV_UPDATE_AWAY, /**< The other user went away. */ - GAIM_CONV_UPDATE_ICON, /**< The other user's buddy icon changed. */ - GAIM_CONV_UPDATE_TITLE, - GAIM_CONV_UPDATE_CHATLEFT, + PURPLE_CONV_ACCOUNT_ONLINE, /**< One of the user's accounts went online. */ + PURPLE_CONV_ACCOUNT_OFFLINE, /**< One of the user's accounts went offline. */ + PURPLE_CONV_UPDATE_AWAY, /**< The other user went away. */ + PURPLE_CONV_UPDATE_ICON, /**< The other user's buddy icon changed. */ + PURPLE_CONV_UPDATE_TITLE, + PURPLE_CONV_UPDATE_CHATLEFT, - GAIM_CONV_UPDATE_FEATURES, /**< The features for a chat have changed */ + PURPLE_CONV_UPDATE_FEATURES, /**< The features for a chat have changed */ -} GaimConvUpdateType; +} PurpleConvUpdateType; /** * The typing state of a user. */ typedef enum { - GAIM_NOT_TYPING = 0, /**< Not typing. */ - GAIM_TYPING, /**< Currently typing. */ - GAIM_TYPED /**< Stopped typing momentarily. */ + PURPLE_NOT_TYPING = 0, /**< Not typing. */ + PURPLE_TYPING, /**< Currently typing. */ + PURPLE_TYPED /**< Stopped typing momentarily. */ -} GaimTypingState; +} PurpleTypingState; /** * Flags applicable to a message. Most will have send, recv or system. */ typedef enum { - GAIM_MESSAGE_SEND = 0x0001, /**< Outgoing message. */ - GAIM_MESSAGE_RECV = 0x0002, /**< Incoming message. */ - GAIM_MESSAGE_SYSTEM = 0x0004, /**< System message. */ - GAIM_MESSAGE_AUTO_RESP = 0x0008, /**< Auto response. */ - GAIM_MESSAGE_ACTIVE_ONLY = 0x0010, /**< Hint to the UI that this + PURPLE_MESSAGE_SEND = 0x0001, /**< Outgoing message. */ + PURPLE_MESSAGE_RECV = 0x0002, /**< Incoming message. */ + PURPLE_MESSAGE_SYSTEM = 0x0004, /**< System message. */ + PURPLE_MESSAGE_AUTO_RESP = 0x0008, /**< Auto response. */ + PURPLE_MESSAGE_ACTIVE_ONLY = 0x0010, /**< Hint to the UI that this message should not be shown in conversations which are only open for internal UI purposes (e.g. for contact-aware conversions). */ - GAIM_MESSAGE_NICK = 0x0020, /**< Contains your nick. */ - GAIM_MESSAGE_NO_LOG = 0x0040, /**< Do not log. */ - GAIM_MESSAGE_WHISPER = 0x0080, /**< Whispered message. */ - GAIM_MESSAGE_ERROR = 0x0200, /**< Error message. */ - GAIM_MESSAGE_DELAYED = 0x0400, /**< Delayed message. */ - GAIM_MESSAGE_RAW = 0x0800, /**< "Raw" message - don't + PURPLE_MESSAGE_NICK = 0x0020, /**< Contains your nick. */ + PURPLE_MESSAGE_NO_LOG = 0x0040, /**< Do not log. */ + PURPLE_MESSAGE_WHISPER = 0x0080, /**< Whispered message. */ + PURPLE_MESSAGE_ERROR = 0x0200, /**< Error message. */ + PURPLE_MESSAGE_DELAYED = 0x0400, /**< Delayed message. */ + PURPLE_MESSAGE_RAW = 0x0800, /**< "Raw" message - don't apply formatting */ - GAIM_MESSAGE_IMAGES = 0x1000 /**< Message contains images */ + PURPLE_MESSAGE_IMAGES = 0x1000 /**< Message contains images */ -} GaimMessageFlags; +} PurpleMessageFlags; /** * Flags applicable to users in Chats. */ typedef enum { - GAIM_CBFLAGS_NONE = 0x0000, /**< No flags */ - GAIM_CBFLAGS_VOICE = 0x0001, /**< Voiced user or "Participant" */ - GAIM_CBFLAGS_HALFOP = 0x0002, /**< Half-op */ - GAIM_CBFLAGS_OP = 0x0004, /**< Channel Op or Moderator */ - GAIM_CBFLAGS_FOUNDER = 0x0008, /**< Channel Founder */ - GAIM_CBFLAGS_TYPING = 0x0010, /**< Currently typing */ + PURPLE_CBFLAGS_NONE = 0x0000, /**< No flags */ + PURPLE_CBFLAGS_VOICE = 0x0001, /**< Voiced user or "Participant" */ + PURPLE_CBFLAGS_HALFOP = 0x0002, /**< Half-op */ + PURPLE_CBFLAGS_OP = 0x0004, /**< Channel Op or Moderator */ + PURPLE_CBFLAGS_FOUNDER = 0x0008, /**< Channel Founder */ + PURPLE_CBFLAGS_TYPING = 0x0010, /**< Currently typing */ -} GaimConvChatBuddyFlags; +} PurpleConvChatBuddyFlags; #include "account.h" #include "buddyicon.h" @@ -142,63 +142,63 @@ * Conversation operations and events. * * Any UI representing a conversation must assign a filled-out - * GaimConversationUiOps structure to the GaimConversation. + * PurpleConversationUiOps structure to the PurpleConversation. */ -struct _GaimConversationUiOps +struct _PurpleConversationUiOps { - void (*create_conversation)(GaimConversation *conv); - void (*destroy_conversation)(GaimConversation *conv); - void (*write_chat)(GaimConversation *conv, const char *who, - const char *message, GaimMessageFlags flags, + void (*create_conversation)(PurpleConversation *conv); + void (*destroy_conversation)(PurpleConversation *conv); + void (*write_chat)(PurpleConversation *conv, const char *who, + const char *message, PurpleMessageFlags flags, time_t mtime); - void (*write_im)(GaimConversation *conv, const char *who, - const char *message, GaimMessageFlags flags, + void (*write_im)(PurpleConversation *conv, const char *who, + const char *message, PurpleMessageFlags flags, time_t mtime); - void (*write_conv)(GaimConversation *conv, const char *name, const char *alias, - const char *message, GaimMessageFlags flags, + void (*write_conv)(PurpleConversation *conv, const char *name, const char *alias, + const char *message, PurpleMessageFlags flags, time_t mtime); - void (*chat_add_users)(GaimConversation *conv, GList *cbuddies, gboolean new_arrivals); + void (*chat_add_users)(PurpleConversation *conv, GList *cbuddies, gboolean new_arrivals); - void (*chat_rename_user)(GaimConversation *conv, const char *old_name, + void (*chat_rename_user)(PurpleConversation *conv, const char *old_name, const char *new_name, const char *new_alias); - void (*chat_remove_users)(GaimConversation *conv, GList *users); - void (*chat_update_user)(GaimConversation *conv, const char *user); + void (*chat_remove_users)(PurpleConversation *conv, GList *users); + void (*chat_update_user)(PurpleConversation *conv, const char *user); - void (*present)(GaimConversation *conv); + void (*present)(PurpleConversation *conv); - gboolean (*has_focus)(GaimConversation *conv); + gboolean (*has_focus)(PurpleConversation *conv); /* Custom Smileys */ - gboolean (*custom_smiley_add)(GaimConversation *conv, const char *smile, gboolean remote); - void (*custom_smiley_write)(GaimConversation *conv, const char *smile, + gboolean (*custom_smiley_add)(PurpleConversation *conv, const char *smile, gboolean remote); + void (*custom_smiley_write)(PurpleConversation *conv, const char *smile, const guchar *data, gsize size); - void (*custom_smiley_close)(GaimConversation *conv, const char *smile); + void (*custom_smiley_close)(PurpleConversation *conv, const char *smile); - void (*send_confirm)(GaimConversation *conv, const char *message); + void (*send_confirm)(PurpleConversation *conv, const char *message); }; /** * Data specific to Instant Messages. */ -struct _GaimConvIm +struct _PurpleConvIm { - GaimConversation *conv; /**< The parent conversation. */ + PurpleConversation *conv; /**< The parent conversation. */ - GaimTypingState typing_state; /**< The current typing state. */ + PurpleTypingState typing_state; /**< The current typing state. */ guint typing_timeout; /**< The typing timer handle. */ time_t type_again; /**< The type again time. */ guint send_typed_timeout; /**< The type again timer handle. */ - GaimBuddyIcon *icon; /**< The buddy icon. */ + PurpleBuddyIcon *icon; /**< The buddy icon. */ }; /** * Data specific to Chats. */ -struct _GaimConvChat +struct _PurpleConvChat { - GaimConversation *conv; /**< The parent conversation. */ + PurpleConversation *conv; /**< The parent conversation. */ GList *in_room; /**< The users in the room. */ GList *ignored; /**< Ignored users. */ @@ -213,13 +213,13 @@ /** * Data for "Chat Buddies" */ -struct _GaimConvChatBuddy +struct _PurpleConvChatBuddy { char *name; /**< The name */ char *alias; /**< The alias */ char *alias_key; /**< The alias key */ gboolean buddy; /**< ChatBuddy is on the blist */ - GaimConvChatBuddyFlags flags; /**< Flags (ops, voice etc.) */ + PurpleConvChatBuddyFlags flags; /**< Flags (ops, voice etc.) */ }; /** @@ -227,11 +227,11 @@ * * The conversation can be an IM or a chat. */ -struct _GaimConversation +struct _PurpleConversation { - GaimConversationType type; /**< The type of conversation. */ + PurpleConversationType type; /**< The type of conversation. */ - GaimAccount *account; /**< The user using this conversation. */ + PurpleAccount *account; /**< The user using this conversation. */ char *name; /**< The name of the conversation. */ @@ -243,18 +243,18 @@ union { - GaimConvIm *im; /**< IM-specific data. */ - GaimConvChat *chat; /**< Chat-specific data. */ + PurpleConvIm *im; /**< IM-specific data. */ + PurpleConvChat *chat; /**< Chat-specific data. */ void *misc; /**< Misc. data. */ } u; - GaimConversationUiOps *ui_ops; /**< UI-specific operations. */ + PurpleConversationUiOps *ui_ops; /**< UI-specific operations. */ void *ui_data; /**< UI-specific data. */ GHashTable *data; /**< Plugin-specific data. */ - GaimConnectionFlags features; /**< The supported features */ + PurpleConnectionFlags features; /**< The supported features */ }; @@ -271,14 +271,14 @@ * Creates a new conversation of the specified type. * * @param type The type of conversation. - * @param account The account opening the conversation window on the gaim + * @param account The account opening the conversation window on the purple * user's end. * @param name The name of the conversation. * * @return The new conversation. */ -GaimConversation *gaim_conversation_new(GaimConversationType type, - GaimAccount *account, +PurpleConversation *purple_conversation_new(PurpleConversationType type, + PurpleAccount *account, const char *name); /** @@ -290,7 +290,7 @@ * * @param conv The conversation to destroy. */ -void gaim_conversation_destroy(GaimConversation *conv); +void purple_conversation_destroy(PurpleConversation *conv); /** @@ -298,7 +298,7 @@ * conversation by displaying the IM dialog. * @param conv The conversation to present */ -void gaim_conversation_present(GaimConversation *conv); +void purple_conversation_present(PurpleConversation *conv); /** @@ -308,7 +308,7 @@ * * @return The conversation's type. */ -GaimConversationType gaim_conversation_get_type(const GaimConversation *conv); +PurpleConversationType purple_conversation_get_type(const PurpleConversation *conv); /** * Sets the specified conversation's UI operations structure. @@ -316,15 +316,15 @@ * @param conv The conversation. * @param ops The UI conversation operations structure. */ -void gaim_conversation_set_ui_ops(GaimConversation *conv, - GaimConversationUiOps *ops); +void purple_conversation_set_ui_ops(PurpleConversation *conv, + PurpleConversationUiOps *ops); /** * Sets the default conversation UI operations structure. * * @param ops The UI conversation operations structure. */ -void gaim_conversations_set_ui_ops(GaimConversationUiOps *ops); +void purple_conversations_set_ui_ops(PurpleConversationUiOps *ops); /** * Returns the specified conversation's UI operations structure. @@ -333,43 +333,43 @@ * * @return The operations structure. */ -GaimConversationUiOps *gaim_conversation_get_ui_ops( - const GaimConversation *conv); +PurpleConversationUiOps *purple_conversation_get_ui_ops( + const PurpleConversation *conv); /** - * Sets the specified conversation's gaim_account. + * Sets the specified conversation's purple_account. * - * This gaim_account represents the user using gaim, not the person the user + * This purple_account represents the user using purple, not the person the user * is having a conversation/chat/flame with. * * @param conv The conversation. - * @param account The gaim_account. + * @param account The purple_account. */ -void gaim_conversation_set_account(GaimConversation *conv, - GaimAccount *account); +void purple_conversation_set_account(PurpleConversation *conv, + PurpleAccount *account); /** - * Returns the specified conversation's gaim_account. + * Returns the specified conversation's purple_account. * - * This gaim_account represents the user using gaim, not the person the user + * This purple_account represents the user using purple, not the person the user * is having a conversation/chat/flame with. * * @param conv The conversation. * - * @return The conversation's gaim_account. + * @return The conversation's purple_account. */ -GaimAccount *gaim_conversation_get_account(const GaimConversation *conv); +PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv); /** - * Returns the specified conversation's gaim_connection. + * Returns the specified conversation's purple_connection. * - * This is the same as gaim_conversation_get_user(conv)->gc. + * This is the same as purple_conversation_get_user(conv)->gc. * * @param conv The conversation. * - * @return The conversation's gaim_connection. + * @return The conversation's purple_connection. */ -GaimConnection *gaim_conversation_get_gc(const GaimConversation *conv); +PurpleConnection *purple_conversation_get_gc(const PurpleConversation *conv); /** * Sets the specified conversation's title. @@ -377,7 +377,7 @@ * @param conv The conversation. * @param title The title. */ -void gaim_conversation_set_title(GaimConversation *conv, const char *title); +void purple_conversation_set_title(PurpleConversation *conv, const char *title); /** * Returns the specified conversation's title. @@ -386,7 +386,7 @@ * * @return The title. */ -const char *gaim_conversation_get_title(const GaimConversation *conv); +const char *purple_conversation_get_title(const PurpleConversation *conv); /** * Automatically sets the specified conversation's title. @@ -396,7 +396,7 @@ * * @param conv The conversation. */ -void gaim_conversation_autoset_title(GaimConversation *conv); +void purple_conversation_autoset_title(PurpleConversation *conv); /** * Sets the specified conversation's name. @@ -404,7 +404,7 @@ * @param conv The conversation. * @param name The conversation's name. */ -void gaim_conversation_set_name(GaimConversation *conv, const char *name); +void purple_conversation_set_name(PurpleConversation *conv, const char *name); /** * Returns the specified conversation's name. @@ -413,7 +413,7 @@ * * @return The conversation's name. */ -const char *gaim_conversation_get_name(const GaimConversation *conv); +const char *purple_conversation_get_name(const PurpleConversation *conv); /** * Enables or disables logging for this conversation. @@ -421,7 +421,7 @@ * @param conv The conversation. * @param log @c TRUE if logging should be enabled, or @c FALSE otherwise. */ -void gaim_conversation_set_logging(GaimConversation *conv, gboolean log); +void purple_conversation_set_logging(PurpleConversation *conv, gboolean log); /** * Returns whether or not logging is enabled for this conversation. @@ -430,44 +430,44 @@ * * @return @c TRUE if logging is enabled, or @c FALSE otherwise. */ -gboolean gaim_conversation_is_logging(const GaimConversation *conv); +gboolean purple_conversation_is_logging(const PurpleConversation *conv); /** * Closes any open logs for this conversation. * * Note that new logs will be opened as necessary (e.g. upon receipt of a * message, if the conversation has logging enabled. To disable logging for - * the remainder of the conversation, use gaim_conversation_set_logging(). + * the remainder of the conversation, use purple_conversation_set_logging(). * * @param conv The conversation. */ -void gaim_conversation_close_logs(GaimConversation *conv); +void purple_conversation_close_logs(PurpleConversation *conv); /** * Returns the specified conversation's IM-specific data. * - * If the conversation type is not GAIM_CONV_TYPE_IM, this will return @c NULL. + * If the conversation type is not PURPLE_CONV_TYPE_IM, this will return @c NULL. * * @param conv The conversation. * * @return The IM-specific data. */ -GaimConvIm *gaim_conversation_get_im_data(const GaimConversation *conv); +PurpleConvIm *purple_conversation_get_im_data(const PurpleConversation *conv); -#define GAIM_CONV_IM(c) (gaim_conversation_get_im_data(c)) +#define PURPLE_CONV_IM(c) (purple_conversation_get_im_data(c)) /** * Returns the specified conversation's chat-specific data. * - * If the conversation type is not GAIM_CONV_TYPE_CHAT, this will return @c NULL. + * If the conversation type is not PURPLE_CONV_TYPE_CHAT, this will return @c NULL. * * @param conv The conversation. * * @return The chat-specific data. */ -GaimConvChat *gaim_conversation_get_chat_data(const GaimConversation *conv); +PurpleConvChat *purple_conversation_get_chat_data(const PurpleConversation *conv); -#define GAIM_CONV_CHAT(c) (gaim_conversation_get_chat_data(c)) +#define PURPLE_CONV_CHAT(c) (purple_conversation_get_chat_data(c)) /** * Sets extra data for a conversation. @@ -476,7 +476,7 @@ * @param key The unique key. * @param data The data to assign. */ -void gaim_conversation_set_data(GaimConversation *conv, const char *key, +void purple_conversation_set_data(PurpleConversation *conv, const char *key, gpointer data); /** @@ -487,7 +487,7 @@ * * @return The data associated with the key. */ -gpointer gaim_conversation_get_data(GaimConversation *conv, const char *key); +gpointer purple_conversation_get_data(PurpleConversation *conv, const char *key); /** * Returns a list of all conversations. @@ -496,40 +496,40 @@ * * @return A GList of all conversations. */ -GList *gaim_get_conversations(void); +GList *purple_get_conversations(void); /** * Returns a list of all IMs. * * @return A GList of all IMs. */ -GList *gaim_get_ims(void); +GList *purple_get_ims(void); /** * Returns a list of all chats. * * @return A GList of all chats. */ -GList *gaim_get_chats(void); +GList *purple_get_chats(void); /** - * Finds a conversation with the specified type, name, and Gaim account. + * Finds a conversation with the specified type, name, and Purple account. * * @param type The type of the conversation. * @param name The name of the conversation. - * @param account The gaim_account associated with the conversation. + * @param account The purple_account associated with the conversation. * * @return The conversation if found, or @c NULL otherwise. */ -GaimConversation *gaim_find_conversation_with_account( - GaimConversationType type, const char *name, - const GaimAccount *account); +PurpleConversation *purple_find_conversation_with_account( + PurpleConversationType type, const char *name, + const PurpleAccount *account); /** * Writes to a conversation window. * * This function should not be used to write IM or chat messages. Use - * gaim_conv_im_write() and gaim_conv_chat_write() instead. Those functions will + * purple_conv_im_write() and purple_conv_chat_write() instead. Those functions will * most likely call this anyway, but they may do their own formatting, * sound playback, etc. * @@ -542,11 +542,11 @@ * @param flags The message flags. * @param mtime The time the message was sent. * - * @see gaim_conv_im_write() - * @see gaim_conv_chat_write() + * @see purple_conv_im_write() + * @see purple_conv_chat_write() */ -void gaim_conversation_write(GaimConversation *conv, const char *who, - const char *message, GaimMessageFlags flags, +void purple_conversation_write(PurpleConversation *conv, const char *who, + const char *message, PurpleMessageFlags flags, time_t mtime); @@ -555,15 +555,15 @@ @param conv The conversation @param features Bitset defining supported features */ -void gaim_conversation_set_features(GaimConversation *conv, - GaimConnectionFlags features); +void purple_conversation_set_features(PurpleConversation *conv, + PurpleConnectionFlags features); /** Get the features supported by the given conversation. @param conv The conversation */ -GaimConnectionFlags gaim_conversation_get_features(GaimConversation *conv); +PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv); /** * Determines if a conversation has focus @@ -573,7 +573,7 @@ * @return @c TRUE if the conversation has focus, @c FALSE if * it does not or the UI does not have a concept of conversation focus */ -gboolean gaim_conversation_has_focus(GaimConversation *conv); +gboolean purple_conversation_has_focus(PurpleConversation *conv); /** * Updates the visual status and UI of a conversation. @@ -581,14 +581,14 @@ * @param conv The conversation. * @param type The update type. */ -void gaim_conversation_update(GaimConversation *conv, GaimConvUpdateType type); +void purple_conversation_update(PurpleConversation *conv, PurpleConvUpdateType type); /** * Calls a function on each conversation. * * @param func The function. */ -void gaim_conversation_foreach(void (*func)(GaimConversation *conv)); +void purple_conversation_foreach(void (*func)(PurpleConversation *conv)); /*@}*/ @@ -605,20 +605,20 @@ * * @return The parent conversation. */ -GaimConversation *gaim_conv_im_get_conversation(const GaimConvIm *im); +PurpleConversation *purple_conv_im_get_conversation(const PurpleConvIm *im); /** * Sets the IM's buddy 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 im The IM. * @param icon The buddy icon. * - * @see gaim_buddy_icon_set_data() + * @see purple_buddy_icon_set_data() */ -void gaim_conv_im_set_icon(GaimConvIm *im, GaimBuddyIcon *icon); +void purple_conv_im_set_icon(PurpleConvIm *im, PurpleBuddyIcon *icon); /** * Returns the IM's buddy icon. @@ -627,7 +627,7 @@ * * @return The buddy icon. */ -GaimBuddyIcon *gaim_conv_im_get_icon(const GaimConvIm *im); +PurpleBuddyIcon *purple_conv_im_get_icon(const PurpleConvIm *im); /** * Sets the IM's typing state. @@ -635,7 +635,7 @@ * @param im The IM. * @param state The typing state. */ -void gaim_conv_im_set_typing_state(GaimConvIm *im, GaimTypingState state); +void purple_conv_im_set_typing_state(PurpleConvIm *im, PurpleTypingState state); /** * Returns the IM's typing state. @@ -644,7 +644,7 @@ * * @return The IM's typing state. */ -GaimTypingState gaim_conv_im_get_typing_state(const GaimConvIm *im); +PurpleTypingState purple_conv_im_get_typing_state(const PurpleConvIm *im); /** * Starts the IM's typing timeout. @@ -652,14 +652,14 @@ * @param im The IM. * @param timeout The timeout. */ -void gaim_conv_im_start_typing_timeout(GaimConvIm *im, int timeout); +void purple_conv_im_start_typing_timeout(PurpleConvIm *im, int timeout); /** * Stops the IM's typing timeout. * * @param im The IM. */ -void gaim_conv_im_stop_typing_timeout(GaimConvIm *im); +void purple_conv_im_stop_typing_timeout(PurpleConvIm *im); /** * Returns the IM's typing timeout. @@ -668,44 +668,44 @@ * * @return The timeout. */ -guint gaim_conv_im_get_typing_timeout(const GaimConvIm *im); +guint purple_conv_im_get_typing_timeout(const PurpleConvIm *im); /** - * Sets the quiet-time when no GAIM_TYPING messages will be sent. + * Sets the quiet-time when no PURPLE_TYPING messages will be sent. * Few protocols need this (maybe only MSN). If the user is still - * typing after this quiet-period, then another GAIM_TYPING message + * typing after this quiet-period, then another PURPLE_TYPING message * will be sent. * * @param im The IM. * @param val The number of seconds to wait before allowing another - * GAIM_TYPING message to be sent to the user. Or 0 to - * not send another GAIM_TYPING message. + * PURPLE_TYPING message to be sent to the user. Or 0 to + * not send another PURPLE_TYPING message. */ -void gaim_conv_im_set_type_again(GaimConvIm *im, unsigned int val); +void purple_conv_im_set_type_again(PurpleConvIm *im, unsigned int val); /** - * Returns the time after which another GAIM_TYPING message should be sent. + * Returns the time after which another PURPLE_TYPING message should be sent. * * @param im The IM. * * @return The time in seconds since the epoch. Or 0 if no additional - * GAIM_TYPING message should be sent. + * PURPLE_TYPING message should be sent. */ -time_t gaim_conv_im_get_type_again(const GaimConvIm *im); +time_t purple_conv_im_get_type_again(const PurpleConvIm *im); /** * Starts the IM's type again timeout. * * @param im The IM. */ -void gaim_conv_im_start_send_typed_timeout(GaimConvIm *im); +void purple_conv_im_start_send_typed_timeout(PurpleConvIm *im); /** * Stops the IM's type again timeout. * * @param im The IM. */ -void gaim_conv_im_stop_send_typed_timeout(GaimConvIm *im); +void purple_conv_im_stop_send_typed_timeout(PurpleConvIm *im); /** * Returns the IM's type again timeout interval. @@ -714,14 +714,14 @@ * * @return The type again timeout interval. */ -guint gaim_conv_im_get_send_typed_timeout(const GaimConvIm *im); +guint purple_conv_im_get_send_typed_timeout(const PurpleConvIm *im); /** * Updates the visual typing notification for an IM conversation. * * @param im The IM. */ -void gaim_conv_im_update_typing(GaimConvIm *im); +void purple_conv_im_update_typing(PurpleConvIm *im); /** * Writes to an IM. @@ -732,8 +732,8 @@ * @param flags The message flags. * @param mtime The time the message was sent. */ -void gaim_conv_im_write(GaimConvIm *im, const char *who, - const char *message, GaimMessageFlags flags, +void purple_conv_im_write(PurpleConvIm *im, const char *who, + const char *message, PurpleMessageFlags flags, time_t mtime); /** @@ -742,14 +742,14 @@ * This is a helper function to find a conversation, write an error to it, and * raise the window. If a conversation with this user doesn't already exist, * the function will return FALSE and the calling function can attempt to present - * the error another way (gaim_notify_error, most likely) + * the error another way (purple_notify_error, most likely) * * @param who The user this error is about * @param account The account this error is on * @param what The error * @return TRUE if the error was presented, else FALSE */ -gboolean gaim_conv_present_error(const char *who, GaimAccount *account, const char *what); +gboolean purple_conv_present_error(const char *who, PurpleAccount *account, const char *what); /** * Sends a message to this IM conversation. @@ -757,7 +757,7 @@ * @param im The IM. * @param message The message to send. */ -void gaim_conv_im_send(GaimConvIm *im, const char *message); +void purple_conv_im_send(PurpleConvIm *im, const char *message); /** * Sends a message to a conversation after confirming with @@ -771,21 +771,21 @@ * @param conv The conversation. * @param message The message to send. */ -void gaim_conv_send_confirm(GaimConversation *conv, const char *message); +void purple_conv_send_confirm(PurpleConversation *conv, const char *message); /** * Sends a message to this IM conversation with specified flags. * * @param im The IM. * @param message The message to send. - * @param flags The GaimMessageFlags flags to use in addition to GAIM_MESSAGE_SEND. + * @param flags The PurpleMessageFlags flags to use in addition to PURPLE_MESSAGE_SEND. */ -void gaim_conv_im_send_with_flags(GaimConvIm *im, const char *message, GaimMessageFlags flags); +void purple_conv_im_send_with_flags(PurpleConvIm *im, const char *message, PurpleMessageFlags flags); /** * Adds a smiley to the conversation's smiley tree. If this returns - * @c TRUE you should call gaim_conv_custom_smiley_write() one or more - * times, and then gaim_conv_custom_smiley_close(). If this returns + * @c TRUE you should call purple_conv_custom_smiley_write() one or more + * times, and then purple_conv_custom_smiley_close(). If this returns * @c FALSE, either the conv or smile were invalid, or the icon was * found in the cache. In either case, calling write or close would * be an error. @@ -796,12 +796,12 @@ * @param chksum The checksum, as a NUL terminated base64 string. * @param remote @c TRUE if the custom smiley is set by the remote user (buddy). * @return @c TRUE if an icon is expected, else FALSE. Note that - * it is an error to never call gaim_conv_custom_smiley_close if + * it is an error to never call purple_conv_custom_smiley_close if * this function returns @c TRUE, but an error to call it if * @c FALSE is returned. */ -gboolean gaim_conv_custom_smiley_add(GaimConversation *conv, const char *smile, +gboolean purple_conv_custom_smiley_add(PurpleConversation *conv, const char *smile, const char *cksum_type, const char *chksum, gboolean remote); @@ -815,21 +815,21 @@ * @param size The length of the data. */ -void gaim_conv_custom_smiley_write(GaimConversation *conv, +void purple_conv_custom_smiley_write(PurpleConversation *conv, const char *smile, const guchar *data, gsize size); /** * Close the custom smiley, all data has been written with - * gaim_conv_custom_smiley_write, and it is no longer valid + * purple_conv_custom_smiley_write, and it is no longer valid * to call that function on that smiley. * - * @param conv The gaim conversation associated with the smiley. + * @param conv The purple conversation associated with the smiley. * @param smile The text associated with the smiley */ -void gaim_conv_custom_smiley_close(GaimConversation *conv, const char *smile); +void purple_conv_custom_smiley_close(PurpleConversation *conv, const char *smile); /*@}*/ @@ -846,21 +846,21 @@ * * @return The parent conversation. */ -GaimConversation *gaim_conv_chat_get_conversation(const GaimConvChat *chat); +PurpleConversation *purple_conv_chat_get_conversation(const PurpleConvChat *chat); /** * Sets the list of users in the chat room. * * @note Calling this function will not update the display of the users. - * Please use gaim_conv_chat_add_user(), gaim_conv_chat_add_users(), - * gaim_conv_chat_remove_user(), and gaim_conv_chat_remove_users() instead. + * Please use purple_conv_chat_add_user(), purple_conv_chat_add_users(), + * purple_conv_chat_remove_user(), and purple_conv_chat_remove_users() instead. * * @param chat The chat. * @param users The list of users. * * @return The list passed. */ -GList *gaim_conv_chat_set_users(GaimConvChat *chat, GList *users); +GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users); /** * Returns a list of users in the chat room. @@ -869,7 +869,7 @@ * * @return The list of users. */ -GList *gaim_conv_chat_get_users(const GaimConvChat *chat); +GList *purple_conv_chat_get_users(const PurpleConvChat *chat); /** * Ignores a user in a chat room. @@ -877,7 +877,7 @@ * @param chat The chat. * @param name The name of the user. */ -void gaim_conv_chat_ignore(GaimConvChat *chat, const char *name); +void purple_conv_chat_ignore(PurpleConvChat *chat, const char *name); /** * Unignores a user in a chat room. @@ -885,7 +885,7 @@ * @param chat The chat. * @param name The name of the user. */ -void gaim_conv_chat_unignore(GaimConvChat *chat, const char *name); +void purple_conv_chat_unignore(PurpleConvChat *chat, const char *name); /** * Sets the list of ignored users in the chat room. @@ -895,7 +895,7 @@ * * @return The list passed. */ -GList *gaim_conv_chat_set_ignored(GaimConvChat *chat, GList *ignored); +GList *purple_conv_chat_set_ignored(PurpleConvChat *chat, GList *ignored); /** * Returns the list of ignored users in the chat room. @@ -904,7 +904,7 @@ * * @return The list of ignored users. */ -GList *gaim_conv_chat_get_ignored(const GaimConvChat *chat); +GList *purple_conv_chat_get_ignored(const PurpleConvChat *chat); /** * Returns the actual name of the specified ignored user, if it exists in @@ -920,7 +920,7 @@ * @return The ignored user if found, complete with prefixes, or @c NULL * if not found. */ -const char *gaim_conv_chat_get_ignored_user(const GaimConvChat *chat, +const char *purple_conv_chat_get_ignored_user(const PurpleConvChat *chat, const char *user); /** @@ -931,7 +931,7 @@ * * @return @c TRUE if the user is in the ignore list; @c FALSE otherwise. */ -gboolean gaim_conv_chat_is_user_ignored(const GaimConvChat *chat, +gboolean purple_conv_chat_is_user_ignored(const PurpleConvChat *chat, const char *user); /** @@ -941,7 +941,7 @@ * @param who The user that set the topic. * @param topic The topic. */ -void gaim_conv_chat_set_topic(GaimConvChat *chat, const char *who, +void purple_conv_chat_set_topic(PurpleConvChat *chat, const char *who, const char *topic); /** @@ -951,7 +951,7 @@ * * @return The chat's topic. */ -const char *gaim_conv_chat_get_topic(const GaimConvChat *chat); +const char *purple_conv_chat_get_topic(const PurpleConvChat *chat); /** * Sets the chat room's ID. @@ -959,7 +959,7 @@ * @param chat The chat. * @param id The ID. */ -void gaim_conv_chat_set_id(GaimConvChat *chat, int id); +void purple_conv_chat_set_id(PurpleConvChat *chat, int id); /** * Returns the chat room's ID. @@ -968,7 +968,7 @@ * * @return The ID. */ -int gaim_conv_chat_get_id(const GaimConvChat *chat); +int purple_conv_chat_get_id(const PurpleConvChat *chat); /** * Writes to a chat. @@ -979,8 +979,8 @@ * @param flags The flags. * @param mtime The time the message was sent. */ -void gaim_conv_chat_write(GaimConvChat *chat, const char *who, - const char *message, GaimMessageFlags flags, +void purple_conv_chat_write(PurpleConvChat *chat, const char *who, + const char *message, PurpleMessageFlags flags, time_t mtime); /** @@ -989,16 +989,16 @@ * @param chat The chat. * @param message The message to send. */ -void gaim_conv_chat_send(GaimConvChat *chat, const char *message); +void purple_conv_chat_send(PurpleConvChat *chat, const char *message); /** * Sends a message to this chat conversation with specified flags. * * @param chat The chat. * @param message The message to send. - * @param flags The GaimMessageFlags flags to use. + * @param flags The PurpleMessageFlags flags to use. */ -void gaim_conv_chat_send_with_flags(GaimConvChat *chat, const char *message, GaimMessageFlags flags); +void purple_conv_chat_send_with_flags(PurpleConvChat *chat, const char *message, PurpleMessageFlags flags); /** * Adds a user to a chat. @@ -1009,8 +1009,8 @@ * @param flags The users flags * @param new_arrival Decides whether or not to show a join notice. */ -void gaim_conv_chat_add_user(GaimConvChat *chat, const char *user, - const char *extra_msg, GaimConvChatBuddyFlags flags, +void purple_conv_chat_add_user(PurpleConvChat *chat, const char *user, + const char *extra_msg, PurpleConvChatBuddyFlags flags, gboolean new_arrival); /** @@ -1030,7 +1030,7 @@ * @param flags The list of flags for each user. * @param new_arrivals Decides whether or not to show join notices. */ -void gaim_conv_chat_add_users(GaimConvChat *chat, GList *users, GList *extra_msgs, +void purple_conv_chat_add_users(PurpleConvChat *chat, GList *users, GList *extra_msgs, GList *flags, gboolean new_arrivals); /** @@ -1040,7 +1040,7 @@ * @param old_user The old username. * @param new_user The new username. */ -void gaim_conv_chat_rename_user(GaimConvChat *chat, const char *old_user, +void purple_conv_chat_rename_user(PurpleConvChat *chat, const char *old_user, const char *new_user); /** @@ -1052,7 +1052,7 @@ * @param user The user that is being removed. * @param reason The optional reason given for the removal. Can be @c NULL. */ -void gaim_conv_chat_remove_user(GaimConvChat *chat, const char *user, +void purple_conv_chat_remove_user(PurpleConvChat *chat, const char *user, const char *reason); /** @@ -1062,7 +1062,7 @@ * @param users The users that are being removed. * @param reason The optional reason given for the removal. Can be @c NULL. */ -void gaim_conv_chat_remove_users(GaimConvChat *chat, GList *users, +void purple_conv_chat_remove_users(PurpleConvChat *chat, GList *users, const char *reason); /** @@ -1073,7 +1073,7 @@ * * @return TRUE if the user is in the chat, FALSE if not */ -gboolean gaim_conv_chat_find_user(GaimConvChat *chat, const char *user); +gboolean purple_conv_chat_find_user(PurpleConvChat *chat, const char *user); /** * Set a users flags in a chat @@ -1082,8 +1082,8 @@ * @param user The user to update. * @param flags The new flags. */ -void gaim_conv_chat_user_set_flags(GaimConvChat *chat, const char *user, - GaimConvChatBuddyFlags flags); +void purple_conv_chat_user_set_flags(PurpleConvChat *chat, const char *user, + PurpleConvChatBuddyFlags flags); /** * Get the flags for a user in a chat @@ -1093,7 +1093,7 @@ * * @return The flags for the user */ -GaimConvChatBuddyFlags gaim_conv_chat_user_get_flags(GaimConvChat *chat, +PurpleConvChatBuddyFlags purple_conv_chat_user_get_flags(PurpleConvChat *chat, const char *user); /** @@ -1101,7 +1101,7 @@ * * @param chat The chat. */ -void gaim_conv_chat_clear_users(GaimConvChat *chat); +void purple_conv_chat_clear_users(PurpleConvChat *chat); /** * Sets your nickname (used for hilighting) for a chat. @@ -1109,7 +1109,7 @@ * @param chat The chat. * @param nick The nick. */ -void gaim_conv_chat_set_nick(GaimConvChat *chat, const char *nick); +void purple_conv_chat_set_nick(PurpleConvChat *chat, const char *nick); /** * Gets your nickname (used for hilighting) for a chat. @@ -1117,17 +1117,17 @@ * @param chat The chat. * @return The nick. */ -const char *gaim_conv_chat_get_nick(GaimConvChat *chat); +const char *purple_conv_chat_get_nick(PurpleConvChat *chat); /** * Finds a chat with the specified chat ID. * - * @param gc The gaim_connection. + * @param gc The purple_connection. * @param id The chat ID. * * @return The chat conversation. */ -GaimConversation *gaim_find_chat(const GaimConnection *gc, int id); +PurpleConversation *purple_find_chat(const PurpleConnection *gc, int id); /** * Lets the core know we left a chat, without destroying it. @@ -1135,7 +1135,7 @@ * * @param chat The chat. */ -void gaim_conv_chat_left(GaimConvChat *chat); +void purple_conv_chat_left(PurpleConvChat *chat); /** * Returns true if we're no longer in this chat, @@ -1146,7 +1146,7 @@ * @return @c TRUE if we left the chat already, @c FALSE if * we're still there. */ -gboolean gaim_conv_chat_has_left(GaimConvChat *chat); +gboolean purple_conv_chat_has_left(PurpleConvChat *chat); /** * Creates a new chat buddy @@ -1157,8 +1157,8 @@ * * @return The new chat buddy */ -GaimConvChatBuddy *gaim_conv_chat_cb_new(const char *name, const char *alias, - GaimConvChatBuddyFlags flags); +PurpleConvChatBuddy *purple_conv_chat_cb_new(const char *name, const char *alias, + PurpleConvChatBuddyFlags flags); /** * Find a chat buddy in a chat @@ -1166,7 +1166,7 @@ * @param chat The chat. * @param name The name of the chat buddy to find. */ -GaimConvChatBuddy *gaim_conv_chat_cb_find(GaimConvChat *chat, const char *name); +PurpleConvChatBuddy *purple_conv_chat_cb_find(PurpleConvChat *chat, const char *name); /** * Get the name of a chat buddy @@ -1175,14 +1175,14 @@ * * @return The name of the chat buddy. */ -const char *gaim_conv_chat_cb_get_name(GaimConvChatBuddy *cb); +const char *purple_conv_chat_cb_get_name(PurpleConvChatBuddy *cb); /** * Destroys a chat buddy * * @param cb The chat buddy to destroy */ -void gaim_conv_chat_cb_destroy(GaimConvChatBuddy *cb); +void purple_conv_chat_cb_destroy(PurpleConvChatBuddy *cb); /*@}*/ @@ -1196,17 +1196,17 @@ * * @return The conversation subsystem handle. */ -void *gaim_conversations_get_handle(void); +void *purple_conversations_get_handle(void); /** * Initializes the conversation subsystem. */ -void gaim_conversations_init(void); +void purple_conversations_init(void); /** * Uninitializes the conversation subsystem. */ -void gaim_conversations_uninit(void); +void purple_conversations_uninit(void); /*@}*/ @@ -1214,4 +1214,4 @@ } #endif -#endif /* _GAIM_CONVERSATION_H_ */ +#endif /* _PURPLE_CONVERSATION_H_ */