Mercurial > pidgin
comparison doc/conversation-signals.dox @ 6609:d470295a4945
[gaim-migrate @ 7133]
I realized I only had 4 more signals in the conversations subsystem to do,
so I finished them.
committer: Tailor Script <tailor@pidgin.im>
| author | Christian Hammond <chipx86@chipx86.com> |
|---|---|
| date | Sun, 24 Aug 2003 07:12:41 +0000 |
| parents | bc219e9efb9a |
| children | 3beb00af2e1a |
comparison
equal
deleted
inserted
replaced
| 6608:bc219e9efb9a | 6609:d470295a4945 |
|---|---|
| 53 @param message The message that was displayed. | 53 @param message The message that was displayed. |
| 54 @endsignaldef | 54 @endsignaldef |
| 55 | 55 |
| 56 @signaldef sending-im-msg | 56 @signaldef sending-im-msg |
| 57 @signalproto | 57 @signalproto |
| 58 void (*sending_im_msg)(GaimAccount *account, const char *receiver, char **message); | 58 void (*sending_im_msg)(GaimAccount *account, const char *receiver, |
| 59 char **message); | |
| 59 @endsignalproto | 60 @endsignalproto |
| 60 @signaldesc | 61 @signaldesc |
| 61 Emitted before sending an IM to a user. @a message is a pointer to the | 62 Emitted before sending an IM to a user. @a message is a pointer to the |
| 62 message string, so the plugin can replace the message before being sent. | 63 message string, so the plugin can replace the message before being sent. |
| 63 @note | 64 @note |
| 67 @param message A pointer to the outgoing message. This can be modified. | 68 @param message A pointer to the outgoing message. This can be modified. |
| 68 @endsignaldef | 69 @endsignaldef |
| 69 | 70 |
| 70 @signaldef sent-im-msg | 71 @signaldef sent-im-msg |
| 71 @signalproto | 72 @signalproto |
| 72 void (*sent_im_msg)(GaimAccount *account, const char *receiver, const char *message); | 73 void (*sent_im_msg)(GaimAccount *account, const char *receiver, |
| 74 const char *message); | |
| 73 @endsignalproto | 75 @endsignalproto |
| 74 @signaldesc | 76 @signaldesc |
| 75 Emitted after sending an IM to a user. | 77 Emitted after sending an IM to a user. |
| 76 @param account The account the message was sent on. | 78 @param account The account the message was sent on. |
| 77 @param receiver The username of the receiver. | 79 @param receiver The username of the receiver. |
| 78 @param message The message that was sent. | 80 @param message The message that was sent. |
| 79 @endsignaldef | 81 @endsignaldef |
| 80 | 82 |
| 81 @signaldef received-im-msg | 83 @signaldef received-im-msg |
| 82 @signalproto | 84 @signalproto |
| 83 gboolean (*received_im_msg)(GaimAccount *account, char **sender, char **message, int *flags); | 85 gboolean (*received_im_msg)(GaimAccount *account, char **sender, |
| 86 char **message, int *flags); | |
| 84 @endsignalproto | 87 @endsignalproto |
| 85 @signaldesc | 88 @signaldesc |
| 86 Emitted when an IM is received. The callback can replace the name of the | 89 Emitted when an IM is received. The callback can replace the name of the |
| 87 sender, the message, or the flags by modifying the pointer to the | 90 sender, the message, or the flags by modifying the pointer to the |
| 88 strings and integer. This can also be used to cancel a message by | 91 strings and integer. This can also be used to cancel a message by |
| 146 @param id The ID of the chat. | 149 @param id The ID of the chat. |
| 147 @endsignaldef | 150 @endsignaldef |
| 148 | 151 |
| 149 @signaldef received-chat-msg | 152 @signaldef received-chat-msg |
| 150 @signalproto | 153 @signalproto |
| 151 gboolean (*received_chat_msg)(GaimAccount *account, char **sender, char **message, int id); | 154 gboolean (*received_chat_msg)(GaimAccount *account, char **sender, |
| 155 char **message, int id); | |
| 152 @endsignalproto | 156 @endsignalproto |
| 153 @signaldesc | 157 @signaldesc |
| 154 Emitted when a chat message is received. The callback can replace the | 158 Emitted when a chat message is received. The callback can replace the |
| 155 name of the sender or the messageby modifying the pointer to the | 159 name of the sender or the messageby modifying the pointer to the |
| 156 strings. This can also be used to cancel displaying a message by | 160 strings. This can also be used to cancel displaying a message by |
| 164 @param id The ID of the chat. | 168 @param id The ID of the chat. |
| 165 @endsignaldef | 169 @endsignaldef |
| 166 | 170 |
| 167 @signaldef conversation-switching | 171 @signaldef conversation-switching |
| 168 @signalproto | 172 @signalproto |
| 169 void (*conversation_switching)(GaimConversation *old_conv, GaimConversation *new_conv); | 173 void (*conversation_switching)(GaimConversation *old_conv, |
| 174 GaimConversation *new_conv); | |
| 170 @endsignalproto | 175 @endsignalproto |
| 171 @signaldesc | 176 @signaldesc |
| 172 Emitted when a window is about to switch from one conversation to | 177 Emitted when a window is about to switch from one conversation to |
| 173 another. | 178 another. |
| 174 @param old_conv The old active conversation. | 179 @param old_conv The old active conversation. |
| 175 @param new_conv The soon-to-be active conversation | 180 @param new_conv The soon-to-be active conversation |
| 176 @endsignaldef | 181 @endsignaldef |
| 177 | 182 |
| 178 @signaldef conversation-switched | 183 @signaldef conversation-switched |
| 179 @signalproto | 184 @signalproto |
| 180 void (*conversation_switched)(GaimConversation *old_conv, GaimConversation *new_conv); | 185 void (*conversation_switched)(GaimConversation *old_conv, |
| 186 GaimConversation *new_conv); | |
| 181 @endsignalproto | 187 @endsignalproto |
| 182 @signaldesc | 188 @signaldesc |
| 183 Emitted when a window switched from one conversation to another. | 189 Emitted when a window switched from one conversation to another. |
| 184 @param old_conv The old active conversation. | 190 @param old_conv The old active conversation. |
| 185 @param new_conv The now active conversation. | 191 @param new_conv The now active conversation. |
| 232 @param conv The chat conversation. | 238 @param conv The chat conversation. |
| 233 @endsignaldef | 239 @endsignaldef |
| 234 | 240 |
| 235 @signaldef chat-buddy-leaving | 241 @signaldef chat-buddy-leaving |
| 236 @signalproto | 242 @signalproto |
| 237 void (*chat_buddy_leaving)(GaimConversation *conv, const char *name, const char *reason); | 243 void (*chat_buddy_leaving)(GaimConversation *conv, const char *name, |
| 244 const char *reason); | |
| 238 @endsignalproto | 245 @endsignalproto |
| 239 @signaldesc | 246 @signaldesc |
| 240 Emitted when a user is leaving a chat, before the user list is updated. | 247 Emitted when a user is leaving a chat, before the user list is updated. |
| 241 This may include an optional reason why the user is leaving. | 248 This may include an optional reason why the user is leaving. |
| 242 @param conv The chat conversation. | 249 @param conv The chat conversation. |
| 244 @param reason The optional reason why the user is leaving. | 251 @param reason The optional reason why the user is leaving. |
| 245 @endsignaldef | 252 @endsignaldef |
| 246 | 253 |
| 247 @signaldef chat-buddy-left | 254 @signaldef chat-buddy-left |
| 248 @signalproto | 255 @signalproto |
| 249 void (*chat_buddy_left)(GaimConversation *conv, const char *name, const char *reason); | 256 void (*chat_buddy_left)(GaimConversation *conv, const char *name, |
| 257 const char *reason); | |
| 250 @endsignalproto | 258 @endsignalproto |
| 251 @signaldesc | 259 @signaldesc |
| 252 Emitted when a user leaves a chat, after the user list is updated. | 260 Emitted when a user leaves a chat, after the user list is updated. |
| 253 This may include an optional reason why the user is leaving. | 261 This may include an optional reason why the user is leaving. |
| 254 @param conv The chat conversation. | 262 @param conv The chat conversation. |
| 256 @param reason The optional reason why the user left the chat. | 264 @param reason The optional reason why the user left the chat. |
| 257 @endsignaldef | 265 @endsignaldef |
| 258 | 266 |
| 259 @signaldef chat-inviting-user | 267 @signaldef chat-inviting-user |
| 260 @signalproto | 268 @signalproto |
| 261 void (*chat_inviting_user)(GaimConversation *conv, const char *name, char **invite_message); | 269 void (*chat_inviting_user)(GaimConversation *conv, const char *name, |
| 270 char **invite_message); | |
| 262 @endsignalproto | 271 @endsignalproto |
| 263 @signaldesc | 272 @signaldesc |
| 264 Emitted when a user is being invited to the chat. The callback can | 273 Emitted when a user is being invited to the chat. The callback can |
| 265 replace the invite message to the invitee by modifying the pointer to | 274 replace the invite message to the invitee by modifying the pointer to |
| 266 the invite message. | 275 the invite message. |
| 272 invited. | 281 invited. |
| 273 @endsignaldef | 282 @endsignaldef |
| 274 | 283 |
| 275 @signaldef chat-invited-user | 284 @signaldef chat-invited-user |
| 276 @signalproto | 285 @signalproto |
| 277 void (*chat-invited-user)(GaimConversation *conv); | 286 void (*chat-invited-user)(GaimConversation *conv, const char *name, |
| 278 @endsignalproto | 287 const char *invite_message); |
| 279 @param conv The conversation. | 288 @endsignalproto |
| 280 @signaldesc | 289 @signaldesc |
| 281 | 290 Emitted when a user invited another user to a chat. |
| 291 @param conv The chat conversation. | |
| 292 @param conv The name of the user that was invited. | |
| 293 @param invite_message The message to be sent to the user when invited. | |
| 282 @endsignaldef | 294 @endsignaldef |
| 283 | 295 |
| 284 @signaldef chat-invited | 296 @signaldef chat-invited |
| 285 @signalproto | 297 @signalproto |
| 286 void (*chat-invited)(GaimConversation *conv); | 298 void (*chat-invited)(GaimAccount *account, const char *inviter, |
| 287 @endsignalproto | 299 const char *invite, const char *invite_message); |
| 288 @param conv The conversation. | 300 @endsignalproto |
| 289 @signaldesc | 301 @signaldesc |
| 290 | 302 Emitted when an account was invited to a chat. |
| 303 @param account The account being invited. | |
| 304 @param inviter The username of the person inviting the account. | |
| 305 @param invitee The username of the account being invited. | |
| 306 @param invite_message The optional invite message. | |
| 291 @endsignaldef | 307 @endsignaldef |
| 292 | 308 |
| 293 @signaldef chat-joined | 309 @signaldef chat-joined |
| 294 @signalproto | 310 @signalproto |
| 295 void (*chat-joined)(GaimConversation *conv); | 311 void (*chat-joined)(GaimConversation *conv); |
| 296 @endsignalproto | 312 @endsignalproto |
| 297 @param conv The conversation. | 313 @signaldesc |
| 298 @signaldesc | 314 Emitted when an account joins a chat room. |
| 299 | 315 @param conv The conversation that joined the chat room. |
| 300 @endsignaldef | 316 @endsignaldef |
| 301 | 317 |
| 302 @signaldef chat-left | 318 @signaldef chat-left |
| 303 @signalproto | 319 @signalproto |
| 304 void (*chat-left)(GaimConversation *conv); | 320 void (*chat-left)(GaimConversation *conv); |
| 305 @endsignalproto | 321 @endsignalproto |
| 306 @param conv The conversation. | 322 @signaldesc |
| 307 @signaldesc | 323 Emitted when an account leaves a chat room. |
| 308 | 324 @param conv The conversation that left the chat room. |
| 309 @endsignaldef | 325 @endsignaldef |
| 310 | 326 |
| 311 */ | 327 */ |
| 312 // vim: syntax=c tw=75 et | 328 // vim: syntax=c tw=75 et |