comparison: libpurple/conversationtypes.h
libpurple/conversationtypes.h
- branch
- soc.2013.gobjectification
- changeset 34648
- a6587d8cf907
- parent 34646
- e7f4631e93f7
- child 34651
- 88c104a20f4b
equal
deleted
inserted
replaced
| 34647:9e5a7a09e60e | 34648:a6587d8cf907 |
|---|---|
| 195 /**************************************************************************/ | 195 /**************************************************************************/ |
| 196 /** @name IM Conversation API */ | 196 /** @name IM Conversation API */ |
| 197 /**************************************************************************/ | 197 /**************************************************************************/ |
| 198 /*@{*/ | 198 /*@{*/ |
| 199 | 199 |
| 200 /** TODO | 200 /** |
| 201 * Returns the GType for the IMConversation object. | 201 * Returns the GType for the IMConversation object. |
| 202 */ | 202 */ |
| 203 GType purple_im_conversation_get_type(void); | 203 GType purple_im_conversation_get_type(void); |
| 204 | 204 |
| 205 /** TODO take from conversation.c purple_conversation_new() | 205 /** |
| 206 * Creates a new IM conversation. | 206 * Creates a new IM conversation. |
| 207 * | 207 * |
| 208 * @param account The account opening the conversation window on the purple | 208 * @param account The account opening the conversation window on the purple |
| 209 * user's end. | 209 * user's end. |
| 210 * @param name Name of the buddy. | 210 * @param name Name of the buddy. |
| 328 * | 328 * |
| 329 * @param im The IM. | 329 * @param im The IM. |
| 330 */ | 330 */ |
| 331 void purple_im_conversation_update_typing(PurpleIMConversation *im); | 331 void purple_im_conversation_update_typing(PurpleIMConversation *im); |
| 332 | 332 |
| 333 /** TODO override | |
| 334 * Writes to an IM. | |
| 335 * | |
| 336 * @param im The IM. | |
| 337 * @param who The user who sent the message. | |
| 338 * @param message The message to write. | |
| 339 * @param flags The message flags. | |
| 340 * @param mtime The time the message was sent. | |
| 341 */ | |
| 342 /*void purple_im_conversation_write(PurpleIMConversation *im, const char *who, | |
| 343 const char *message, PurpleMessageFlags flags, | |
| 344 time_t mtime);*/ | |
| 345 | |
| 346 /** TODO write forward | |
| 347 * Sends a message to this IM conversation. | |
| 348 * | |
| 349 * @param im The IM. | |
| 350 * @param message The message to send. | |
| 351 */ | |
| 352 /*void purple_im_conversation_send(PurpleIMConversation *im, const char *message);*/ | |
| 353 | |
| 354 /** TODO override | |
| 355 * Sends a message to this IM conversation with specified flags. | |
| 356 * | |
| 357 * @param im The IM. | |
| 358 * @param message The message to send. | |
| 359 * @param flags The PurpleMessageFlags flags to use in addition to | |
| 360 * PURPLE_MESSAGE_SEND. | |
| 361 */ | |
| 362 /*void purple_im_conversation_send_with_flags(PurpleIMConversation *im, | |
| 363 const char *message, PurpleMessageFlags flags);*/ | |
| 364 | |
| 365 /*@}*/ | 333 /*@}*/ |
| 366 | 334 |
| 367 /**************************************************************************/ | 335 /**************************************************************************/ |
| 368 /** @name Chat Conversation API */ | 336 /** @name Chat Conversation API */ |
| 369 /**************************************************************************/ | 337 /**************************************************************************/ |
| 370 /*@{*/ | 338 /*@{*/ |
| 371 | 339 |
| 372 /** TODO | 340 /** |
| 373 * Returns the GType for the ChatConversation object. | 341 * Returns the GType for the ChatConversation object. |
| 374 */ | 342 */ |
| 375 GType purple_chat_conversation_get_type(void); | 343 GType purple_chat_conversation_get_type(void); |
| 376 | 344 |
| 377 /** TODO take from conversation.c purple_conversation_new() | 345 /** |
| 378 * Creates a new chat conversation. | 346 * Creates a new chat conversation. |
| 379 * | 347 * |
| 380 * @param account The account opening the conversation window on the purple | 348 * @param account The account opening the conversation window on the purple |
| 381 * user's end. | 349 * user's end. |
| 382 * @param name The name of the conversation. | 350 * @param name The name of the conversation. |
| 476 * | 444 * |
| 477 * @return The chat's topic. | 445 * @return The chat's topic. |
| 478 */ | 446 */ |
| 479 const char *purple_chat_conversation_get_topic(const PurpleChatConversation *chat); | 447 const char *purple_chat_conversation_get_topic(const PurpleChatConversation *chat); |
| 480 | 448 |
| 481 /** TODO | 449 /** |
| 482 * Returns who set the chat room's topic. | 450 * Returns who set the chat room's topic. |
| 483 * | 451 * |
| 484 * @param chat The chat. | 452 * @param chat The chat. |
| 485 * | 453 * |
| 486 * @return Who set the topic. | 454 * @return Who set the topic. |
| 501 * @param chat The chat. | 469 * @param chat The chat. |
| 502 * | 470 * |
| 503 * @return The ID. | 471 * @return The ID. |
| 504 */ | 472 */ |
| 505 int purple_chat_conversation_get_id(const PurpleChatConversation *chat); | 473 int purple_chat_conversation_get_id(const PurpleChatConversation *chat); |
| 506 | |
| 507 /** TODO override | |
| 508 * Writes to a chat. | |
| 509 * | |
| 510 * @param chat The chat. | |
| 511 * @param who The user who sent the message. | |
| 512 * @param message The message to write. | |
| 513 * @param flags The flags. | |
| 514 * @param mtime The time the message was sent. | |
| 515 */ | |
| 516 /*void purple_chat_conversation_write(PurpleChatConversation *chat, const char *who, | |
| 517 const char *message, PurpleMessageFlags flags, | |
| 518 time_t mtime);*/ | |
| 519 | |
| 520 /** TODO write forward | |
| 521 * Sends a message to this chat conversation. | |
| 522 * | |
| 523 * @param chat The chat. | |
| 524 * @param message The message to send. | |
| 525 */ | |
| 526 /*void purple_chat_conversation_send(PurpleChatConversation *chat, const char *message);*/ | |
| 527 | |
| 528 /** TODO override | |
| 529 * Sends a message to this chat conversation with specified flags. | |
| 530 * | |
| 531 * @param chat The chat. | |
| 532 * @param message The message to send. | |
| 533 * @param flags The PurpleMessageFlags flags to use. | |
| 534 */ | |
| 535 /*void purple_chat_conversation_send_with_flags(PurpleChatConversation *chat, | |
| 536 const char *message, PurpleMessageFlags flags);*/ | |
| 537 | 474 |
| 538 /** | 475 /** |
| 539 * Adds a user to a chat. | 476 * Adds a user to a chat. |
| 540 * | 477 * |
| 541 * @param chat The chat. | 478 * @param chat The chat. |
| 702 /**************************************************************************/ | 639 /**************************************************************************/ |
| 703 /** @name Chat Conversation Buddy API */ | 640 /** @name Chat Conversation Buddy API */ |
| 704 /**************************************************************************/ | 641 /**************************************************************************/ |
| 705 /*@{*/ | 642 /*@{*/ |
| 706 | 643 |
| 707 /** TODO | 644 /** |
| 708 * Returns the GType for the ChatConversationBuddy object. | 645 * Returns the GType for the ChatConversationBuddy object. |
| 709 */ | 646 */ |
| 710 GType purple_chat_conversation_buddy_get_type(void); | 647 GType purple_chat_conversation_buddy_get_type(void); |
| 711 | 648 |
| 712 /** | 649 /** |
| 749 */ | 686 */ |
| 750 void | 687 void |
| 751 purple_chat_conversation_buddy_set_attributes(PurpleChatConversation *chat, | 688 purple_chat_conversation_buddy_set_attributes(PurpleChatConversation *chat, |
| 752 PurpleChatConversationBuddy *cb, GList *keys, GList *values); | 689 PurpleChatConversationBuddy *cb, GList *keys, GList *values); |
| 753 | 690 |
| 754 /** TODO GObjectify | 691 /** |
| 755 * Creates a new chat buddy | 692 * Creates a new chat buddy |
| 756 * | 693 * |
| 757 * @param name The name. | 694 * @param name The name. |
| 758 * @param alias The alias. | 695 * @param alias The alias. |
| 759 * @param flags The flags. | 696 * @param flags The flags. |
| 816 * | 753 * |
| 817 * @return TRUE if the chat buddy is on the buddy list. | 754 * @return TRUE if the chat buddy is on the buddy list. |
| 818 */ | 755 */ |
| 819 gboolean purple_chat_conversation_buddy_is_buddy(const PurpleChatConversationBuddy *cb); | 756 gboolean purple_chat_conversation_buddy_is_buddy(const PurpleChatConversationBuddy *cb); |
| 820 | 757 |
| 821 /** TODO finalize/dispose | |
| 822 * Destroys a chat buddy | |
| 823 * | |
| 824 * @param cb The chat buddy to destroy | |
| 825 */ | |
| 826 /*void purple_chat_conversation_buddy_destroy(PurpleChatConversationBuddy *cb);*/ | |
| 827 | |
| 828 /*@}*/ | 758 /*@}*/ |
| 829 | 759 |
| 830 G_END_DECLS | 760 G_END_DECLS |
| 831 | 761 |
| 832 #endif /* _PURPLE_CONVERSATION_TYPES_H_ */ | 762 #endif /* _PURPLE_CONVERSATION_TYPES_H_ */ |
