Mercurial > pidgin

comparison doc/conversation-signals.dox @ 16183:8cf53d7a0887

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update the Doxygen signals documentation to match the new struct names.
author Richard Laager <rlaager@wiktel.com>
date Mon, 16 Apr 2007 00:50:57 +0000
parents a2ccce52ab3d
children 36b09c6f7957
comparison
equal deleted inserted replaced
16182:36d9409dab58 16183:8cf53d7a0887
31 @signal chat-topic-changed 31 @signal chat-topic-changed
32 @endsignals 32 @endsignals
33 33
34 @signaldef writing-im-msg 34 @signaldef writing-im-msg
35 @signalproto 35 @signalproto
36 gboolean (*writing_im_msg)(GaimAccount *account, const char *who, 36 gboolean (*writing_im_msg)(PurpleAccount *account, const char *who,
37 char **message, GaimConversation *conv, 37 char **message, PurpleConversation *conv,
38 GaimMessageFlags flags); 38 PurpleMessageFlags flags);
39 @endsignalproto 39 @endsignalproto
40 @signaldesc 40 @signaldesc
41 Emitted before a message is written in an IM conversation. If the 41 Emitted before a message is written in an IM conversation. If the
42 message is changed, then the changed message is displayed and logged 42 message is changed, then the changed message is displayed and logged
43 instead of the original message. 43 instead of the original message.
51 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. 51 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
52 @endsignaldef 52 @endsignaldef
53 53
54 @signaldef wrote-im-msg 54 @signaldef wrote-im-msg
55 @signalproto 55 @signalproto
56 void (*wrote_im_msg)(GaimAccount *account, const char *who, 56 void (*wrote_im_msg)(PurpleAccount *account, const char *who,
57 char *message, GaimConversation *conv, 57 char *message, PurpleConversation *conv,
58 GaimMessageFlags flags); 58 PurpleMessageFlags flags);
59 @endsignalproto 59 @endsignalproto
60 @signaldesc 60 @signaldesc
61 Emitted after a message is written and possibly displayed in a conversation. 61 Emitted after a message is written and possibly displayed in a conversation.
62 @param account The account. 62 @param account The account.
63 @param who The name of the user. 63 @param who The name of the user.
66 @param flags Flags for this message. 66 @param flags Flags for this message.
67 @endsignaldef 67 @endsignaldef
68 68
69 @signaldef sending-im-msg 69 @signaldef sending-im-msg
70 @signalproto 70 @signalproto
71 void (*sending_im_msg)(GaimAccount *account, const char *receiver, 71 void (*sending_im_msg)(PurpleAccount *account, const char *receiver,
72 char **message); 72 char **message);
73 @endsignalproto 73 @endsignalproto
74 @signaldesc 74 @signaldesc
75 Emitted before sending an IM to a user. @a message is a pointer to the 75 Emitted before sending an IM to a user. @a message is a pointer to the
76 message string, so the plugin can replace the message before being sent. 76 message string, so the plugin can replace the message before being sent.
81 @param message A pointer to the outgoing message. This can be modified. 81 @param message A pointer to the outgoing message. This can be modified.
82 @endsignaldef 82 @endsignaldef
83 83
84 @signaldef sent-im-msg 84 @signaldef sent-im-msg
85 @signalproto 85 @signalproto
86 void (*sent_im_msg)(GaimAccount *account, const char *receiver, 86 void (*sent_im_msg)(PurpleAccount *account, const char *receiver,
87 const char *message); 87 const char *message);
88 @endsignalproto 88 @endsignalproto
89 @signaldesc 89 @signaldesc
90 Emitted after sending an IM to a user. 90 Emitted after sending an IM to a user.
91 @param account The account the message was sent on. 91 @param account The account the message was sent on.
93 @param message The message that was sent. 93 @param message The message that was sent.
94 @endsignaldef 94 @endsignaldef
95 95
96 @signaldef receiving-im-msg 96 @signaldef receiving-im-msg
97 @signalproto 97 @signalproto
98 gboolean (*receiving_im_msg)(GaimAccount *account, char **sender, 98 gboolean (*receiving_im_msg)(PurpleAccount *account, char **sender,
99 char **message, GaimConversation *conv, 99 char **message, PurpleConversation *conv,
100 GaimMessageFlags *flags); 100 PurpleMessageFlags *flags);
101 @endsignalproto 101 @endsignalproto
102 @signaldesc 102 @signaldesc
103 Emitted when an IM is received. The callback can replace the name of the 103 Emitted when an IM is received. The callback can replace the name of the
104 sender, the message, or the flags by modifying the pointer to the 104 sender, the message, or the flags by modifying the pointer to the
105 strings and integer. This can also be used to cancel a message by 105 strings and integer. This can also be used to cancel a message by
114 @param flags A pointer to the IM message flags. 114 @param flags A pointer to the IM message flags.
115 @endsignaldef 115 @endsignaldef
116 116
117 @signaldef received-im-msg 117 @signaldef received-im-msg
118 @signalproto 118 @signalproto
119 void (*received_im_msg)(GaimAccount *account, char *sender, char *message, 119 void (*received_im_msg)(PurpleAccount *account, char *sender, char *message,
120 GaimConversation *conv, GaimMessageFlags flags); 120 PurpleConversation *conv, PurpleMessageFlags flags);
121 @endsignalproto 121 @endsignalproto
122 @signaldesc 122 @signaldesc
123 Emitted after an IM is received. 123 Emitted after an IM is received.
124 @param account The account the message was received on. 124 @param account The account the message was received on.
125 @param sender The username of the sender. 125 @param sender The username of the sender.
128 @param flags The IM message flags. 128 @param flags The IM message flags.
129 @endsignaldef 129 @endsignaldef
130 130
131 @signaldef writing-chat-msg 131 @signaldef writing-chat-msg
132 @signalproto 132 @signalproto
133 gboolean (*writing_chat_msg)(GaimAccount *account, const char *who, 133 gboolean (*writing_chat_msg)(PurpleAccount *account, const char *who,
134 char **message, GaimConversation *conv, 134 char **message, PurpleConversation *conv,
135 GaimMessageFlags flags); 135 PurpleMessageFlags flags);
136 @endsignalproto 136 @endsignalproto
137 @signaldesc 137 @signaldesc
138 Emitted before a message is written in a chat conversation. If the 138 Emitted before a message is written in a chat conversation. If the
139 message is changed, then the changed message is displayed and logged 139 message is changed, then the changed message is displayed and logged
140 instead of the original message. 140 instead of the original message.
148 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. 148 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
149 @endsignaldef 149 @endsignaldef
150 150
151 @signaldef wrote-chat-msg 151 @signaldef wrote-chat-msg
152 @signalproto 152 @signalproto
153 void (*wrote_chat_msg)(GaimAccount *account, const char *who, 153 void (*wrote_chat_msg)(PurpleAccount *account, const char *who,
154 char *message, GaimConversation *conv, 154 char *message, PurpleConversation *conv,
155 GaimMessageFlags flags); 155 PurpleMessageFlags flags);
156 @endsignalproto 156 @endsignalproto
157 @signaldesc 157 @signaldesc
158 Emitted after a message is written and possibly displayed in a chat. 158 Emitted after a message is written and possibly displayed in a chat.
159 @param account The account. 159 @param account The account.
160 @param who The name of the user. 160 @param who The name of the user.
163 @param flags Flags for this message. 163 @param flags Flags for this message.
164 @endsignaldef 164 @endsignaldef
165 165
166 @signaldef sending-chat-msg 166 @signaldef sending-chat-msg
167 @signalproto 167 @signalproto
168 void (*sending_chat_msg)(GaimAccount *account, char **message, int id); 168 void (*sending_chat_msg)(PurpleAccount *account, char **message, int id);
169 @endsignalproto 169 @endsignalproto
170 @signaldesc 170 @signaldesc
171 Emitted before sending a message to a chat. @a message is a pointer to the 171 Emitted before sending a message to a chat. @a message is a pointer to the
172 message string, so the plugin can replace the message before being sent. 172 message string, so the plugin can replace the message before being sent.
173 @note 173 @note
177 @param id The ID of the chat. 177 @param id The ID of the chat.
178 @endsignaldef 178 @endsignaldef
179 179
180 @signaldef sent-chat-msg 180 @signaldef sent-chat-msg
181 @signalproto 181 @signalproto
182 void (*sent_chat_msg)(GaimAccount *account, const char *message, int id); 182 void (*sent_chat_msg)(PurpleAccount *account, const char *message, int id);
183 @endsignalproto 183 @endsignalproto
184 @signaldesc 184 @signaldesc
185 Emitted after sending a message to a chat. 185 Emitted after sending a message to a chat.
186 @param account The account the message was sent on. 186 @param account The account the message was sent on.
187 @param message The message that was sent. 187 @param message The message that was sent.
188 @param id The ID of the chat. 188 @param id The ID of the chat.
189 @endsignaldef 189 @endsignaldef
190 190
191 @signaldef receiving-chat-msg 191 @signaldef receiving-chat-msg
192 @signalproto 192 @signalproto
193 gboolean (*receiving_chat_msg)(GaimAccount *account, char **sender, 193 gboolean (*receiving_chat_msg)(PurpleAccount *account, char **sender,
194 char **message, GaimConversation *conv, int *flags); 194 char **message, PurpleConversation *conv, int *flags);
195 @endsignalproto 195 @endsignalproto
196 @signaldesc 196 @signaldesc
197 Emitted when a chat message is received. The callback can replace the 197 Emitted when a chat message is received. The callback can replace the
198 name of the sender, the message, or the flags by modifying the pointer to the 198 name of the sender, the message, or the flags by modifying the pointer to the
199 strings. This can also be used to cancel displaying a message by 199 strings. This can also be used to cancel displaying a message by
208 @param flags A pointer to the chat message flags 208 @param flags A pointer to the chat message flags
209 @endsignaldef 209 @endsignaldef
210 210
211 @signaldef received-chat-msg 211 @signaldef received-chat-msg
212 @signalproto 212 @signalproto
213 void (*received_chat_msg)(GaimAccount *account, char *sender, char *message, 213 void (*received_chat_msg)(PurpleAccount *account, char *sender, char *message,
214 GaimConversation *conv, GaimMessageFlags flags); 214 PurpleConversation *conv, PurpleMessageFlags flags);
215 @endsignalproto 215 @endsignalproto
216 @signaldesc 216 @signaldesc
217 Emitted after a chat message is received. 217 Emitted after a chat message is received.
218 @param account The account the message was received on. 218 @param account The account the message was received on.
219 @param sender The username of the sender. 219 @param sender The username of the sender.
222 @param flags The chat message flags. 222 @param flags The chat message flags.
223 @endsignaldef 223 @endsignaldef
224 224
225 @signaldef conversation-created 225 @signaldef conversation-created
226 @signalproto 226 @signalproto
227 void (*conversation_created)(GaimConversation *conv); 227 void (*conversation_created)(PurpleConversation *conv);
228 @endsignalproto 228 @endsignalproto
229 @signaldesc 229 @signaldesc
230 Emitted when a new conversation is created. 230 Emitted when a new conversation is created.
231 @param conv The new conversation. 231 @param conv The new conversation.
232 @endsignaldef 232 @endsignaldef
233 233
234 @signaldef conversation-updated 234 @signaldef conversation-updated
235 @signalproto 235 @signalproto
236 void (*conversation_updated)(GaimConversation *conv, 236 void (*conversation_updated)(PurpleConversation *conv,
237 GaimConvUpdateType type); 237 PurpleConvUpdateType type);
238 @endsignalproto 238 @endsignalproto
239 @signaldesc 239 @signaldesc
240 Emitted when a conversation is updated. 240 Emitted when a conversation is updated.
241 @param conv The conversation that was updated. 241 @param conv The conversation that was updated.
242 @param type The type of update that was made. 242 @param type The type of update that was made.
243 @endsignaldef 243 @endsignaldef
244 244
245 @signaldef deleting-conversation 245 @signaldef deleting-conversation
246 @signalproto 246 @signalproto
247 void (*deleting_conversation)(GaimConversation *conv); 247 void (*deleting_conversation)(PurpleConversation *conv);
248 @endsignalproto 248 @endsignalproto
249 @signaldesc 249 @signaldesc
250 Emitted just before a conversation is to be destroyed. 250 Emitted just before a conversation is to be destroyed.
251 @param conv The conversation that's about to be destroyed. 251 @param conv The conversation that's about to be destroyed.
252 @endsignaldef 252 @endsignaldef
253 253
254 @signaldef buddy-typing 254 @signaldef buddy-typing
255 @signalproto 255 @signalproto
256 void (*buddy_typing)(GaimAccount *account, const char *name); 256 void (*buddy_typing)(PurpleAccount *account, const char *name);
257 @endsignalproto 257 @endsignalproto
258 @signaldesc 258 @signaldesc
259 Emitted when a buddy starts typing in a conversation window. 259 Emitted when a buddy starts typing in a conversation window.
260 @param account The account of the user which is typing. 260 @param account The account of the user which is typing.
261 @param name The name of the user which is typing. 261 @param name The name of the user which is typing.
262 @endsignaldef 262 @endsignaldef
263 263
264 @signaldef buddy-typing-stopped 264 @signaldef buddy-typing-stopped
265 @signalproto 265 @signalproto
266 void (*buddy_typing_stopped)(GaimAccount *account, const char *name); 266 void (*buddy_typing_stopped)(PurpleAccount *account, const char *name);
267 @endsignalproto 267 @endsignalproto
268 @signaldesc 268 @signaldesc
269 Emitted when a buddy stops typing in a conversation window. 269 Emitted when a buddy stops typing in a conversation window.
270 @param account The account of the user which stopped typing. 270 @param account The account of the user which stopped typing.
271 @param name The name of the user which stopped typing. 271 @param name The name of the user which stopped typing.
272 @endsignaldef 272 @endsignaldef
273 273
274 @signaldef chat-buddy-joining 274 @signaldef chat-buddy-joining
275 @signalproto 275 @signalproto
276 gboolean (*chat_buddy_joining)(GaimConversation *conv, const char *name, 276 gboolean (*chat_buddy_joining)(PurpleConversation *conv, const char *name,
277 GaimConvChatBuddyFlags flags); 277 PurpleConvChatBuddyFlags flags);
278 @endsignalproto 278 @endsignalproto
279 @signaldesc 279 @signaldesc
280 Emitted when a buddy is joining a chat, before the list of 280 Emitted when a buddy is joining a chat, before the list of
281 users in the chat updates to include the new user. 281 users in the chat updates to include the new user.
282 @return @c TRUE if the join should be hidden, or @c FALSE otherwise. 282 @return @c TRUE if the join should be hidden, or @c FALSE otherwise.
285 @param flags The flags of the user that is joining the conversation. 285 @param flags The flags of the user that is joining the conversation.
286 @endsignaldef 286 @endsignaldef
287 287
288 @signaldef chat-buddy-joined 288 @signaldef chat-buddy-joined
289 @signalproto 289 @signalproto
290 void (*chat_buddy_joined)(GaimConversation *conv, const char *name, 290 void (*chat_buddy_joined)(PurpleConversation *conv, const char *name,
291 GaimConvChatBuddyFlags flags, 291 PurpleConvChatBuddyFlags flags,
292 gboolean new_arrival); 292 gboolean new_arrival);
293 @endsignalproto 293 @endsignalproto
294 @signaldesc 294 @signaldesc
295 Emitted when a buddy joined a chat, after the users list is updated. 295 Emitted when a buddy joined a chat, after the users list is updated.
296 @param conv The chat conversation. 296 @param conv The chat conversation.
299 @param new_arrival If the buddy is a new arrival. 299 @param new_arrival If the buddy is a new arrival.
300 @endsignaldef 300 @endsignaldef
301 301
302 @signaldef chat-buddy-flags 302 @signaldef chat-buddy-flags
303 @signalproto 303 @signalproto
304 void (*chat_buddy_flags)(GaimConversation *conv, const char *name, 304 void (*chat_buddy_flags)(PurpleConversation *conv, const char *name,
305 GaimConvChatBuddyFlags oldflags, 305 PurpleConvChatBuddyFlags oldflags,
306 GaimConvChatBuddyFlags newflags); 306 PurpleConvChatBuddyFlags newflags);
307 @endsignalproto 307 @endsignalproto
308 @signaldesc 308 @signaldesc
309 Emitted when a user in a chat changes flags. 309 Emitted when a user in a chat changes flags.
310 @param conv The chat conversation. 310 @param conv The chat conversation.
311 @param name The name of the user. 311 @param name The name of the user.
313 @param newflags The new flags. 313 @param newflags The new flags.
314 @endsignaldef 314 @endsignaldef
315 315
316 @signaldef chat-buddy-leaving 316 @signaldef chat-buddy-leaving
317 @signalproto 317 @signalproto
318 gboolean (*chat_buddy_leaving)(GaimConversation *conv, const char *name, 318 gboolean (*chat_buddy_leaving)(PurpleConversation *conv, const char *name,
319 const char *reason); 319 const char *reason);
320 @endsignalproto 320 @endsignalproto
321 @signaldesc 321 @signaldesc
322 Emitted when a user is leaving a chat, before the user list is updated. 322 Emitted when a user is leaving a chat, before the user list is updated.
323 This may include an optional reason why the user is leaving. 323 This may include an optional reason why the user is leaving.
327 @param reason The optional reason why the user is leaving. 327 @param reason The optional reason why the user is leaving.
328 @endsignaldef 328 @endsignaldef
329 329
330 @signaldef chat-buddy-left 330 @signaldef chat-buddy-left
331 @signalproto 331 @signalproto
332 void (*chat_buddy_left)(GaimConversation *conv, const char *name, 332 void (*chat_buddy_left)(PurpleConversation *conv, const char *name,
333 const char *reason); 333 const char *reason);
334 @endsignalproto 334 @endsignalproto
335 @signaldesc 335 @signaldesc
336 Emitted when a user leaves a chat, after the user list is updated. 336 Emitted when a user leaves a chat, after the user list is updated.
337 This may include an optional reason why the user is leaving. 337 This may include an optional reason why the user is leaving.
340 @param reason The optional reason why the user left the chat. 340 @param reason The optional reason why the user left the chat.
341 @endsignaldef 341 @endsignaldef
342 342
343 @signaldef chat-inviting-user 343 @signaldef chat-inviting-user
344 @signalproto 344 @signalproto
345 void (*chat_inviting_user)(GaimConversation *conv, const char *name, 345 void (*chat_inviting_user)(PurpleConversation *conv, const char *name,
346 char **invite_message); 346 char **invite_message);
347 @endsignalproto 347 @endsignalproto
348 @signaldesc 348 @signaldesc
349 Emitted when a user is being invited to the chat. The callback can 349 Emitted when a user is being invited to the chat. The callback can
350 replace the invite message to the invitee by modifying the pointer to 350 replace the invite message to the invitee by modifying the pointer to
357 invited. 357 invited.
358 @endsignaldef 358 @endsignaldef
359 359
360 @signaldef chat-invited-user 360 @signaldef chat-invited-user
361 @signalproto 361 @signalproto
362 void (*chat_invited_user)(GaimConversation *conv, const char *name, 362 void (*chat_invited_user)(PurpleConversation *conv, const char *name,
363 const char *invite_message); 363 const char *invite_message);
364 @endsignalproto 364 @endsignalproto
365 @signaldesc 365 @signaldesc
366 Emitted when a user invited another user to a chat. 366 Emitted when a user invited another user to a chat.
367 @param conv The chat conversation. 367 @param conv The chat conversation.
369 @param invite_message The message to be sent to the user when invited. 369 @param invite_message The message to be sent to the user when invited.
370 @endsignaldef 370 @endsignaldef
371 371
372 @signaldef chat-invited 372 @signaldef chat-invited
373 @signalproto 373 @signalproto
374 gint (*chat_invited)(GaimAccount *account, const char *inviter, 374 gint (*chat_invited)(PurpleAccount *account, const char *inviter,
375 const char *chat, const char *invite_message 375 const char *chat, const char *invite_message
376 const GHashTable *components); 376 const GHashTable *components);
377 @endsignalproto 377 @endsignalproto
378 @signaldesc 378 @signaldesc
379 Emitted when an account was invited to a chat. 379 Emitted when an account was invited to a chat.
388 default behavior will be maintained: the user will be prompted. 388 default behavior will be maintained: the user will be prompted.
389 @endsignaldef 389 @endsignaldef
390 390
391 @signaldef chat-joined 391 @signaldef chat-joined
392 @signalproto 392 @signalproto
393 void (*chat_joined)(GaimConversation *conv); 393 void (*chat_joined)(PurpleConversation *conv);
394 @endsignalproto 394 @endsignalproto
395 @signaldesc 395 @signaldesc
396 Emitted when an account joins a chat room. 396 Emitted when an account joins a chat room.
397 @param conv The conversation that joined the chat room. 397 @param conv The conversation that joined the chat room.
398 @endsignaldef 398 @endsignaldef
399 399
400 @signaldef chat-left 400 @signaldef chat-left
401 @signalproto 401 @signalproto
402 void (*chat_left)(GaimConversation *conv); 402 void (*chat_left)(PurpleConversation *conv);
403 @endsignalproto 403 @endsignalproto
404 @signaldesc 404 @signaldesc
405 Emitted when an account leaves a chat room. 405 Emitted when an account leaves a chat room.
406 @param conv The conversation that left the chat room. 406 @param conv The conversation that left the chat room.
407 @endsignaldef 407 @endsignaldef
408 408
409 @signaldef chat-topic-changed 409 @signaldef chat-topic-changed
410 @signalproto 410 @signalproto
411 void (*chat_topic_changed)(GaimConversation *conv, const char *who, const char *topic); 411 void (*chat_topic_changed)(PurpleConversation *conv, const char *who, const char *topic);
412 @endsignalproto 412 @endsignalproto
413 @signaldesc 413 @signaldesc
414 Emitted when the topic is changed in a chat. 414 Emitted when the topic is changed in a chat.
415 @param conv The conversation whose topic changed. 415 @param conv The conversation whose topic changed.
416 @param who The name of the person that changed the topic. 416 @param who The name of the person that changed the topic.