pidgin: libpurple/conversation.h comparison

comparison libpurple/conversation.h @ 32819:2c6510167895 default tip

propagate from branch 'im.pidgin.pidgin.2.x.y' (head 3315c5dfbd0ad16511bdcf865e5b07c02d07df24) to branch 'im.pidgin.pidgin' (head cbd1eda6bcbf0565ae7766396bb8f6f419cb6a9a)

author	Elliott Sales de Andrade <qulogic@pidgin.im>
date	Sat, 02 Jun 2012 02:30:49 +0000
parents	98520ee78f12
children

comparison

equal deleted inserted replaced

-:01ff09d4a463
+:2c6510167895
 	PURPLE_MESSAGE_RAW         = 0x0800, /**< "Raw" message - don't
 	                                        apply formatting         */
 	PURPLE_MESSAGE_IMAGES      = 0x1000, /**< Message contains images  */
 	PURPLE_MESSAGE_NOTIFY      = 0x2000, /**< Message is a notification */
 	PURPLE_MESSAGE_NO_LINKIFY  = 0x4000, /**< Message should not be auto-
-										   linkified @since 2.1.0 */
+										   linkified */
 	PURPLE_MESSAGE_INVISIBLE   = 0x8000  /**< Message should not be displayed */
 } PurpleMessageFlags;
 /**
 * Flags applicable to users in Chats.
 	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             */
-	PURPLE_CBFLAGS_AWAY          = 0x0020  /**< Currently away. @since 2.8.0 */
+	PURPLE_CBFLAGS_AWAY          = 0x0020  /**< Currently away.              */
 } PurpleConvChatBuddyFlags;
 #include "account.h"
 #include "buddyicon.h"
 	void (*_purple_reserved2)(void);
 	void (*_purple_reserved3)(void);
 	void (*_purple_reserved4)(void);
 };
-/**
+G_BEGIN_DECLS
-* Data specific to Instant Messages.
-*/
-struct _PurpleConvIm
-{
-	PurpleConversation *conv;            /**< The parent conversation.     */
-	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. */
-	PurpleBuddyIcon *icon;               /**< The buddy icon.              */
-};
-/**
-* Data specific to Chats.
-*/
-struct _PurpleConvChat
-{
-	PurpleConversation *conv;          /**< The parent conversation.      */
-	GList *in_room;                  /**< The users in the room.
-	                                  *   @deprecated Will be removed in 3.0.0
-									  */
-	GList *ignored;                  /**< Ignored users.                */
-	char  *who;                      /**< The person who set the topic. */
-	char  *topic;                    /**< The topic.                    */
-	int    id;                       /**< The chat ID.                  */
-	char *nick;                      /**< Your nick in this chat.       */
-	gboolean left;                   /**< We left the chat and kept the window open */
-	GHashTable *users;               /**< Hash table of the users in the room.
-	                                  *   @since 2.9.0
-	                                  */
-};
-/**
-* Data for "Chat Buddies"
-*/
-struct _PurpleConvChatBuddy
-{
-	char *name;                      /**< The chat participant's name in the chat. */
-	char *alias;                     /**< The chat participant's alias, if known;
-	                                  *   @a NULL otherwise.
-	                                  */
-	char *alias_key;                 /**< A string by which this buddy will be sorted,
-	                                  *   or @c NULL if the buddy should be sorted by
-	                                  *   its @c name.  (This is currently always @c
-	                                  *   NULL.)
-	                                  */
-	gboolean buddy;                  /**< @a TRUE if this chat participant is on the
-	                                  *   buddy list; @a FALSE otherwise.
-	                                  */
-	PurpleConvChatBuddyFlags flags;  /**< A bitwise OR of flags for this participant,
-	                                  *   such as whether they are a channel operator.
-	                                  */
-	GHashTable *attributes;          /**< A hash table of attributes about the user, such as
-*   real name, user@host, etc.
-*/
-	gpointer ui_data;                /** < The UI can put whatever it wants here. */
-};
-/**
-* Description of a conversation message
-*
-* @since 2.2.0
-*/
-struct _PurpleConvMessage
-{
-	char *who;
-	char *what;
-	PurpleMessageFlags flags;
-	time_t when;
-	PurpleConversation *conv;  /**< @since 2.3.0 */
-	char *alias;               /**< @since 2.3.0 */
-};
-/**
-* A core representation of a conversation between two or more people.
-*
-* The conversation can be an IM or a chat.
-*/
-struct _PurpleConversation
-{
-	PurpleConversationType type;  /**< The type of conversation.          */
-	PurpleAccount *account;       /**< The user using this conversation.  */
-	char *name;                 /**< The name of the conversation.      */
-	char *title;                /**< The window title.                  */
-	gboolean logging;           /**< The status of logging.             */
-	GList *logs;                /**< This conversation's logs           */
-	union
-	{
-		PurpleConvIm   *im;       /**< IM-specific data.                  */
-		PurpleConvChat *chat;     /**< Chat-specific data.                */
-		void *misc;             /**< Misc. data.                        */
-	} u;
-	PurpleConversationUiOps *ui_ops;           /**< UI-specific operations. */
-	void *ui_data;                           /**< UI-specific data.       */
-	GHashTable *data;                        /**< Plugin-specific data.   */
-	PurpleConnectionFlags features; /**< The supported features */
-	GList *message_history;         /**< Message history, as a GList of PurpleConvMessage's */
-};
-#ifdef __cplusplus
-extern "C" {
-#endif
 /**************************************************************************/
 /** @name Conversation API                                                */
 /**************************************************************************/
 /*@{*/
 PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv);
 /**
 * Returns the specified conversation's purple_connection.
 *
-* This is the same as purple_conversation_get_user(conv)->gc.
-*
 * @param conv The conversation.
 *
 * @return The conversation's purple_connection.
 */
-PurpleConnection *purple_conversation_get_gc(const PurpleConversation *conv);
+PurpleConnection *purple_conversation_get_connection(const PurpleConversation *conv);
 /**
 * Sets the specified conversation's title.
 *
 * @param conv  The conversation.
 * @param conv   The conversation
 *
 * @return  A GList of PurpleConvMessage's. The must not modify the list or the data within.
 *          The list contains the newest message at the beginning, and the oldest message at
 *          the end.
-*
-* @since 2.2.0
 */
 GList *purple_conversation_get_message_history(PurpleConversation *conv);
 /**
 * Clear the message history of a conversation.
 *
 * @param conv  The conversation
-*
-* @since 2.2.0
 */
 void purple_conversation_clear_message_history(PurpleConversation *conv);
 /**
 * Get the sender from a PurpleConvMessage
 *
 * @param msg   A PurpleConvMessage
 *
 * @return   The name of the sender of the message
-*
+*/
-* @since 2.2.0
+const char *purple_conversation_message_get_sender(const PurpleConvMessage *msg);
-*/
-const char *purple_conversation_message_get_sender(PurpleConvMessage *msg);
 /**
 * Get the message from a PurpleConvMessage
 *
 * @param msg   A PurpleConvMessage
 *
 * @return   The name of the sender of the message
-*
+*/
-* @since 2.2.0
+const char *purple_conversation_message_get_message(const PurpleConvMessage *msg);
-*/
-const char *purple_conversation_message_get_message(PurpleConvMessage *msg);
 /**
 * Get the message-flags of a PurpleConvMessage
 *
 * @param msg   A PurpleConvMessage
 *
 * @return   The message flags
-*
+*/
-* @since 2.2.0
+PurpleMessageFlags purple_conversation_message_get_flags(const PurpleConvMessage *msg);
-*/
-PurpleMessageFlags purple_conversation_message_get_flags(PurpleConvMessage *msg);
 /**
 * Get the timestamp of a PurpleConvMessage
 *
 * @param msg   A PurpleConvMessage
 *
 * @return   The timestamp of the message
-*
+*/
-* @since 2.2.0
+time_t purple_conversation_message_get_timestamp(const PurpleConvMessage *msg);
-*/
-time_t purple_conversation_message_get_timestamp(PurpleConvMessage *msg);
+/**
+* Get the alias from a PurpleConvMessage
+*
+* @param msg   A PurpleConvMessage
+*
+* @return   The alias of the sender of the message
+*/
+const char *purple_conversation_message_get_alias(const PurpleConvMessage *msg);
+/**
+* Get the conversation associated with the PurpleConvMessage
+*
+* @param msg   A PurpleConvMessage
+*
+* @return   The conversation
+*/
+PurpleConversation *purple_conversation_message_get_conv(const PurpleConvMessage *msg);
+/**
+* Set the UI data associated with this conversation.
+*
+* @param conv			The conversation.
+* @param ui_data		A pointer to associate with this conversation.
+*/
+void purple_conversation_set_ui_data(PurpleConversation *conv, gpointer ui_data);
+/**
+* Get the UI data associated with this conversation.
+*
+* @param conv			The conversation.
+*
+* @return The UI data associated with this conversation.  This is a
+*         convenience field provided to the UIs--it is not
+*         used by the libpurple core.
+*/
+gpointer purple_conversation_get_ui_data(const PurpleConversation *conv);
 /*@}*/
 /**************************************************************************/
 * @param chat The chat.
 *
 * @return The parent conversation.
 */
 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 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.
-*
-* @deprecated This function will be removed in 3.0.0.  You shouldn't be using it anyway.
-*/
-GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users);
 /**
 * Returns a list of users in the chat room.  The members of the list
 * are PurpleConvChatBuddy objects.
 *
 * @param chat     The chat.
 * @param user     The user to invite to the chat.
 * @param message  The message to send with the invitation.
 * @param confirm  Prompt before sending the invitation. The user is always
 *                 prompted if either \a user or \a message is @c NULL.
-*
-* @since 2.6.0
 */
 void purple_conv_chat_invite_user(PurpleConvChat *chat, const char *user,
 		const char *message, gboolean confirm);
 /**
 * @param name The name of the chat buddy to find.
 */
 PurpleConvChatBuddy *purple_conv_chat_cb_find(PurpleConvChat *chat, const char *name);
 /**
+* Set the UI data associated with this chat buddy.
+*
+* @param cb			The chat buddy
+* @param ui_data		A pointer to associate with this chat buddy.
+*/
+void purple_conv_chat_cb_set_ui_data(PurpleConvChatBuddy *cb, gpointer ui_data);
+/**
+* Get the UI data associated with this chat buddy.
+*
+* @param cb			The chat buddy.
+*
+* @return The UI data associated with this chat buddy.  This is a
+*         convenience field provided to the UIs--it is not
+*         used by the libpurple core.
+*/
+gpointer purple_conv_chat_cb_get_ui_data(const PurpleConvChatBuddy *conv);
+/**
+* Get the alias of a chat buddy
+*
+* @param cb    The chat buddy.
+*
+* @return The alias of the chat buddy.
+*/
+const char *purple_conv_chat_cb_get_alias(const PurpleConvChatBuddy *cb);
+/**
 * Get the name of a chat buddy
 *
 * @param cb    The chat buddy.
 *
 * @return The name of the chat buddy.
 */
-const char *purple_conv_chat_cb_get_name(PurpleConvChatBuddy *cb);
+const char *purple_conv_chat_cb_get_name(const PurpleConvChatBuddy *cb);
+/**
+* Get the flags of a chat buddy.
+*
+* @param cb	The chat buddy.
+*
+* @return The flags of the chat buddy.
+*/
+PurpleConvChatBuddyFlags purple_conv_chat_cb_get_flags(const PurpleConvChatBuddy *cb);
+/**
+* Indicates if this chat buddy is on the buddy list.
+*
+* @param cb	The chat buddy.
+*
+* @return TRUE if the chat buddy is on the buddy list.
+*/
+gboolean purple_conv_chat_cb_is_buddy(const PurpleConvChatBuddy *cb);
 /**
 * Destroys a chat buddy
 *
 * @param cb The chat buddy to destroy
 * @param conv The conversation.
 *
 * @return  A list of PurpleMenuAction items, harvested by the
 *          chat-extended-menu signal. The list and the menuaction
 *          items should be freed by the caller.
-*
-* @since 2.1.0
 */
 GList * purple_conversation_get_extended_menu(PurpleConversation *conv);
 /**
 * Perform a command in a conversation. Similar to @see purple_cmd_do_command
 * @param markup  @c NULL, or the formatted command line.
 * @param error   If the command failed errormsg is filled in with the appropriate error
 *                message, if not @c NULL. It must be freed by the caller with g_free().
 *
 * @return  @c TRUE if the command was executed successfully, @c FALSE otherwise.
-*
-* @since 2.1.0
 */
 gboolean purple_conversation_do_command(PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **error);
 /*@}*/
 */
 void purple_conversations_uninit(void);
 /*@}*/
-#ifdef __cplusplus
+G_END_DECLS
-}
-#endif
 #endif /* _PURPLE_CONVERSATION_H_ */

Mercurial > pidgin

comparison libpurple/conversation.h @ 32819:2c6510167895 default tip