Mercurial > pidgin.yaz
comparison libpurple/conversation.h @ 32687:02a2e8183b1d
Clean the API documentation in preparation for 3.0.0 by removing all the old @since tags.
author | andrew.victor@mxit.com |
---|---|
date | Sun, 25 Sep 2011 18:56:58 +0000 |
parents | a617a949e545 |
children | 0f94ec89f0bc 1877fd446f8d |
comparison
equal
deleted
inserted
replaced
32685:9d5b87e1a4d0 | 32687:02a2e8183b1d |
---|---|
123 PURPLE_MESSAGE_RAW = 0x0800, /**< "Raw" message - don't | 123 PURPLE_MESSAGE_RAW = 0x0800, /**< "Raw" message - don't |
124 apply formatting */ | 124 apply formatting */ |
125 PURPLE_MESSAGE_IMAGES = 0x1000, /**< Message contains images */ | 125 PURPLE_MESSAGE_IMAGES = 0x1000, /**< Message contains images */ |
126 PURPLE_MESSAGE_NOTIFY = 0x2000, /**< Message is a notification */ | 126 PURPLE_MESSAGE_NOTIFY = 0x2000, /**< Message is a notification */ |
127 PURPLE_MESSAGE_NO_LINKIFY = 0x4000, /**< Message should not be auto- | 127 PURPLE_MESSAGE_NO_LINKIFY = 0x4000, /**< Message should not be auto- |
128 linkified @since 2.1.0 */ | 128 linkified */ |
129 PURPLE_MESSAGE_INVISIBLE = 0x8000 /**< Message should not be displayed */ | 129 PURPLE_MESSAGE_INVISIBLE = 0x8000 /**< Message should not be displayed */ |
130 } PurpleMessageFlags; | 130 } PurpleMessageFlags; |
131 | 131 |
132 /** | 132 /** |
133 * Flags applicable to users in Chats. | 133 * Flags applicable to users in Chats. |
138 PURPLE_CBFLAGS_VOICE = 0x0001, /**< Voiced user or "Participant" */ | 138 PURPLE_CBFLAGS_VOICE = 0x0001, /**< Voiced user or "Participant" */ |
139 PURPLE_CBFLAGS_HALFOP = 0x0002, /**< Half-op */ | 139 PURPLE_CBFLAGS_HALFOP = 0x0002, /**< Half-op */ |
140 PURPLE_CBFLAGS_OP = 0x0004, /**< Channel Op or Moderator */ | 140 PURPLE_CBFLAGS_OP = 0x0004, /**< Channel Op or Moderator */ |
141 PURPLE_CBFLAGS_FOUNDER = 0x0008, /**< Channel Founder */ | 141 PURPLE_CBFLAGS_FOUNDER = 0x0008, /**< Channel Founder */ |
142 PURPLE_CBFLAGS_TYPING = 0x0010, /**< Currently typing */ | 142 PURPLE_CBFLAGS_TYPING = 0x0010, /**< Currently typing */ |
143 PURPLE_CBFLAGS_AWAY = 0x0020 /**< Currently away. @since 2.8.0 */ | 143 PURPLE_CBFLAGS_AWAY = 0x0020 /**< Currently away. */ |
144 | 144 |
145 } PurpleConvChatBuddyFlags; | 145 } PurpleConvChatBuddyFlags; |
146 | 146 |
147 #include "account.h" | 147 #include "account.h" |
148 #include "buddyicon.h" | 148 #include "buddyicon.h" |
279 char *topic; /**< The topic. */ | 279 char *topic; /**< The topic. */ |
280 int id; /**< The chat ID. */ | 280 int id; /**< The chat ID. */ |
281 char *nick; /**< Your nick in this chat. */ | 281 char *nick; /**< Your nick in this chat. */ |
282 | 282 |
283 gboolean left; /**< We left the chat and kept the window open */ | 283 gboolean left; /**< We left the chat and kept the window open */ |
284 GHashTable *users; /**< Hash table of the users in the room. | 284 GHashTable *users; /**< Hash table of the users in the room. */ |
285 * @since 2.9.0 | |
286 */ | |
287 }; | 285 }; |
288 | 286 |
289 /** | 287 /** |
290 * Data for "Chat Buddies" | 288 * Data for "Chat Buddies" |
291 */ | 289 */ |
326 gpointer ui_data; | 324 gpointer ui_data; |
327 }; | 325 }; |
328 | 326 |
329 /** | 327 /** |
330 * Description of a conversation message | 328 * Description of a conversation message |
331 * | |
332 * @since 2.2.0 | |
333 */ | 329 */ |
334 struct _PurpleConvMessage | 330 struct _PurpleConvMessage |
335 { | 331 { |
336 char *who; | 332 char *who; |
337 char *what; | 333 char *what; |
338 PurpleMessageFlags flags; | 334 PurpleMessageFlags flags; |
339 time_t when; | 335 time_t when; |
340 PurpleConversation *conv; /**< @since 2.3.0 */ | 336 PurpleConversation *conv; |
341 char *alias; /**< @since 2.3.0 */ | 337 char *alias; |
342 }; | 338 }; |
343 | 339 |
344 /** | 340 /** |
345 * A core representation of a conversation between two or more people. | 341 * A core representation of a conversation between two or more people. |
346 * | 342 * |
756 * @param conv The conversation | 752 * @param conv The conversation |
757 * | 753 * |
758 * @return A GList of PurpleConvMessage's. The must not modify the list or the data within. | 754 * @return A GList of PurpleConvMessage's. The must not modify the list or the data within. |
759 * The list contains the newest message at the beginning, and the oldest message at | 755 * The list contains the newest message at the beginning, and the oldest message at |
760 * the end. | 756 * the end. |
761 * | |
762 * @since 2.2.0 | |
763 */ | 757 */ |
764 GList *purple_conversation_get_message_history(PurpleConversation *conv); | 758 GList *purple_conversation_get_message_history(PurpleConversation *conv); |
765 | 759 |
766 /** | 760 /** |
767 * Clear the message history of a conversation. | 761 * Clear the message history of a conversation. |
768 * | 762 * |
769 * @param conv The conversation | 763 * @param conv The conversation |
770 * | |
771 * @since 2.2.0 | |
772 */ | 764 */ |
773 void purple_conversation_clear_message_history(PurpleConversation *conv); | 765 void purple_conversation_clear_message_history(PurpleConversation *conv); |
774 | 766 |
775 /** | 767 /** |
776 * Get the sender from a PurpleConvMessage | 768 * Get the sender from a PurpleConvMessage |
777 * | 769 * |
778 * @param msg A PurpleConvMessage | 770 * @param msg A PurpleConvMessage |
779 * | 771 * |
780 * @return The name of the sender of the message | 772 * @return The name of the sender of the message |
781 * | |
782 * @since 2.2.0 | |
783 */ | 773 */ |
784 const char *purple_conversation_message_get_sender(PurpleConvMessage *msg); | 774 const char *purple_conversation_message_get_sender(PurpleConvMessage *msg); |
785 | 775 |
786 /** | 776 /** |
787 * Get the message from a PurpleConvMessage | 777 * Get the message from a PurpleConvMessage |
788 * | 778 * |
789 * @param msg A PurpleConvMessage | 779 * @param msg A PurpleConvMessage |
790 * | 780 * |
791 * @return The name of the sender of the message | 781 * @return The name of the sender of the message |
792 * | |
793 * @since 2.2.0 | |
794 */ | 782 */ |
795 const char *purple_conversation_message_get_message(PurpleConvMessage *msg); | 783 const char *purple_conversation_message_get_message(PurpleConvMessage *msg); |
796 | 784 |
797 /** | 785 /** |
798 * Get the message-flags of a PurpleConvMessage | 786 * Get the message-flags of a PurpleConvMessage |
799 * | 787 * |
800 * @param msg A PurpleConvMessage | 788 * @param msg A PurpleConvMessage |
801 * | 789 * |
802 * @return The message flags | 790 * @return The message flags |
803 * | |
804 * @since 2.2.0 | |
805 */ | 791 */ |
806 PurpleMessageFlags purple_conversation_message_get_flags(PurpleConvMessage *msg); | 792 PurpleMessageFlags purple_conversation_message_get_flags(PurpleConvMessage *msg); |
807 | 793 |
808 /** | 794 /** |
809 * Get the timestamp of a PurpleConvMessage | 795 * Get the timestamp of a PurpleConvMessage |
810 * | 796 * |
811 * @param msg A PurpleConvMessage | 797 * @param msg A PurpleConvMessage |
812 * | 798 * |
813 * @return The timestamp of the message | 799 * @return The timestamp of the message |
814 * | |
815 * @since 2.2.0 | |
816 */ | 800 */ |
817 time_t purple_conversation_message_get_timestamp(PurpleConvMessage *msg); | 801 time_t purple_conversation_message_get_timestamp(PurpleConvMessage *msg); |
818 | 802 |
819 /** | 803 /** |
820 * Set the UI data associated with this conversation. | 804 * Set the UI data associated with this conversation. |
1377 * @param chat The chat. | 1361 * @param chat The chat. |
1378 * @param user The user to invite to the chat. | 1362 * @param user The user to invite to the chat. |
1379 * @param message The message to send with the invitation. | 1363 * @param message The message to send with the invitation. |
1380 * @param confirm Prompt before sending the invitation. The user is always | 1364 * @param confirm Prompt before sending the invitation. The user is always |
1381 * prompted if either \a user or \a message is @c NULL. | 1365 * prompted if either \a user or \a message is @c NULL. |
1382 * | |
1383 * @since 2.6.0 | |
1384 */ | 1366 */ |
1385 void purple_conv_chat_invite_user(PurpleConvChat *chat, const char *user, | 1367 void purple_conv_chat_invite_user(PurpleConvChat *chat, const char *user, |
1386 const char *message, gboolean confirm); | 1368 const char *message, gboolean confirm); |
1387 | 1369 |
1388 /** | 1370 /** |
1438 * @param conv The conversation. | 1420 * @param conv The conversation. |
1439 * | 1421 * |
1440 * @return A list of PurpleMenuAction items, harvested by the | 1422 * @return A list of PurpleMenuAction items, harvested by the |
1441 * chat-extended-menu signal. The list and the menuaction | 1423 * chat-extended-menu signal. The list and the menuaction |
1442 * items should be freed by the caller. | 1424 * items should be freed by the caller. |
1443 * | |
1444 * @since 2.1.0 | |
1445 */ | 1425 */ |
1446 GList * purple_conversation_get_extended_menu(PurpleConversation *conv); | 1426 GList * purple_conversation_get_extended_menu(PurpleConversation *conv); |
1447 | 1427 |
1448 /** | 1428 /** |
1449 * Perform a command in a conversation. Similar to @see purple_cmd_do_command | 1429 * Perform a command in a conversation. Similar to @see purple_cmd_do_command |
1453 * @param markup @c NULL, or the formatted command line. | 1433 * @param markup @c NULL, or the formatted command line. |
1454 * @param error If the command failed errormsg is filled in with the appropriate error | 1434 * @param error If the command failed errormsg is filled in with the appropriate error |
1455 * message, if not @c NULL. It must be freed by the caller with g_free(). | 1435 * message, if not @c NULL. It must be freed by the caller with g_free(). |
1456 * | 1436 * |
1457 * @return @c TRUE if the command was executed successfully, @c FALSE otherwise. | 1437 * @return @c TRUE if the command was executed successfully, @c FALSE otherwise. |
1458 * | |
1459 * @since 2.1.0 | |
1460 */ | 1438 */ |
1461 gboolean purple_conversation_do_command(PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **error); | 1439 gboolean purple_conversation_do_command(PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **error); |
1462 | 1440 |
1463 /*@}*/ | 1441 /*@}*/ |
1464 | 1442 |