Mercurial > pidgin3 / file comparison

comparison: libpurple/conversations.h

libpurple/conversations.h

branch
gtkdoc-conversion
changeset 35393
00f876b129bc
parent 35307
2af82f31e6a8
child 35394
38facb8226d4
child 37035
e85ed7f4d6e3
equal deleted inserted replaced
35392:cc123f0d84af 35393:00f876b129bc
38 /*@{*/ 38 /*@{*/
39 39
40 /** 40 /**
41 * Adds a conversation to the list of conversations. 41 * Adds a conversation to the list of conversations.
42 * 42 *
43 * @param conv The conversation. 43 * @conv: The conversation.
44 */ 44 */
45 void purple_conversations_add(PurpleConversation *conv); 45 void purple_conversations_add(PurpleConversation *conv);
46 46
47 /** 47 /**
48 * Removes a conversation from the list of conversations. 48 * Removes a conversation from the list of conversations.
49 * 49 *
50 * @param conv The conversation. 50 * @conv: The conversation.
51 */ 51 */
52 void purple_conversations_remove(PurpleConversation *conv); 52 void purple_conversations_remove(PurpleConversation *conv);
53 53
54 /** 54 /**
55 * Returns a list of all conversations. 55 * Returns a list of all conversations.
56 * 56 *
57 * This list includes both IMs and chats. 57 * This list includes both IMs and chats.
58 * 58 *
59 * @constreturn A GList of all conversations. 59 * Returns: (TODO const): A GList of all conversations.
60 */ 60 */
61 GList *purple_conversations_get_all(void); 61 GList *purple_conversations_get_all(void);
62 62
63 /** 63 /**
64 * Returns a list of all IMs. 64 * Returns a list of all IMs.
65 * 65 *
66 * @constreturn A GList of all IMs. 66 * Returns: (TODO const): A GList of all IMs.
67 */ 67 */
68 GList *purple_conversations_get_ims(void); 68 GList *purple_conversations_get_ims(void);
69 69
70 /** 70 /**
71 * Returns a list of all chats. 71 * Returns a list of all chats.
72 * 72 *
73 * @constreturn A GList of all chats. 73 * Returns: (TODO const): A GList of all chats.
74 */ 74 */
75 GList *purple_conversations_get_chats(void); 75 GList *purple_conversations_get_chats(void);
76 76
77 /** 77 /**
78 * Finds a conversation of any type with the specified name and Purple account. 78 * Finds a conversation of any type with the specified name and Purple account.
79 * 79 *
80 * @param name The name of the conversation. 80 * @name: The name of the conversation.
81 * @param account The account associated with the conversation. 81 * @account: The account associated with the conversation.
82 * 82 *
83 * @return The conversation if found, or @c NULL otherwise. 83 * Returns: The conversation if found, or %NULL otherwise.
84 */ 84 */
85 PurpleConversation *purple_conversations_find_with_account(const char *name, 85 PurpleConversation *purple_conversations_find_with_account(const char *name,
86 const PurpleAccount *account); 86 const PurpleAccount *account);
87 87
88 /** 88 /**
89 * Finds an IM with the specified name and Purple account. 89 * Finds an IM with the specified name and Purple account.
90 * 90 *
91 * @param name The name of the conversation. 91 * @name: The name of the conversation.
92 * @param account The account associated with the conversation. 92 * @account: The account associated with the conversation.
93 * 93 *
94 * @return The conversation if found, or @c NULL otherwise. 94 * Returns: The conversation if found, or %NULL otherwise.
95 */ 95 */
96 PurpleIMConversation *purple_conversations_find_im_with_account(const char *name, 96 PurpleIMConversation *purple_conversations_find_im_with_account(const char *name,
97 const PurpleAccount *account); 97 const PurpleAccount *account);
98 98
99 /** 99 /**
100 * Finds a chat with the specified name and Purple account. 100 * Finds a chat with the specified name and Purple account.
101 * 101 *
102 * @param name The name of the conversation. 102 * @name: The name of the conversation.
103 * @param account The account associated with the conversation. 103 * @account: The account associated with the conversation.
104 * 104 *
105 * @return The conversation if found, or @c NULL otherwise. 105 * Returns: The conversation if found, or %NULL otherwise.
106 */ 106 */
107 PurpleChatConversation *purple_conversations_find_chat_with_account(const char *name, 107 PurpleChatConversation *purple_conversations_find_chat_with_account(const char *name,
108 const PurpleAccount *account); 108 const PurpleAccount *account);
109 109
110 /** 110 /**
111 * Finds a chat with the specified chat ID. 111 * Finds a chat with the specified chat ID.
112 * 112 *
113 * @param gc The purple_connection. 113 * @gc: The purple_connection.
114 * @param id The chat ID. 114 * @id: The chat ID.
115 * 115 *
116 * @return The chat conversation. 116 * Returns: The chat conversation.
117 */ 117 */
118 PurpleChatConversation *purple_conversations_find_chat(const PurpleConnection *gc, int id); 118 PurpleChatConversation *purple_conversations_find_chat(const PurpleConnection *gc, int id);
119 119
120 /** 120 /**
121 * Sets the default conversation UI operations structure. 121 * Sets the default conversation UI operations structure.
122 * 122 *
123 * @param ops The UI conversation operations structure. 123 * @ops: The UI conversation operations structure.
124 */ 124 */
125 void purple_conversations_set_ui_ops(PurpleConversationUiOps *ops); 125 void purple_conversations_set_ui_ops(PurpleConversationUiOps *ops);
126 126
127 /** 127 /**
128 * Gets the default conversation UI operations structure. 128 * Gets the default conversation UI operations structure.
129 * 129 *
130 * @return The UI conversation operations structure. 130 * Returns: The UI conversation operations structure.
131 */ 131 */
132 PurpleConversationUiOps *purple_conversations_get_ui_ops(void); 132 PurpleConversationUiOps *purple_conversations_get_ui_ops(void);
133 133
134 /** 134 /**
135 * Returns the conversation subsystem handle. 135 * Returns the conversation subsystem handle.
136 * 136 *
137 * @return The conversation subsystem handle. 137 * Returns: The conversation subsystem handle.
138 */ 138 */
139 void *purple_conversations_get_handle(void); 139 void *purple_conversations_get_handle(void);
140 140
141 /** 141 /**
142 * Initializes the conversation subsystem. 142 * Initializes the conversation subsystem.

Mercurial Repository: pidgin3

mercurial