Mercurial > pidgin
comparison doc/conversation-signals.dox @ 8276:3c49a619969f
[gaim-migrate @ 9000]
Documentation fix from The_Developer, and I trimmed whitespace stuff.
committer: Tailor Script <tailor@pidgin.im>
| author | Christian Hammond <chipx86@chipx86.com> |
|---|---|
| date | Tue, 17 Feb 2004 04:09:28 +0000 |
| parents | ab0750ac5154 |
| children | 374477c0dd76 |
comparison
equal
deleted
inserted
replaced
| 8275:3b8387166187 | 8276:3c49a619969f |
|---|---|
| 33 gboolean (*writing_im_msg)(GaimAccount *account, GaimConversation *conv, char **message); | 33 gboolean (*writing_im_msg)(GaimAccount *account, GaimConversation *conv, char **message); |
| 34 @endsignalproto | 34 @endsignalproto |
| 35 @signaldesc | 35 @signaldesc |
| 36 Emitted before a message is displayed in an IM conversation or sent to a remote user. | 36 Emitted before a message is displayed in an IM conversation or sent to a remote user. |
| 37 @a message is a pointer to a string, so the plugin can replace the | 37 @a message is a pointer to a string, so the plugin can replace the |
| 38 message that will be displayed along with the message that will be sent. | 38 message that will be displayed along with the message that will be sent. |
| 39 This can also be used to cancel an outgoing message by returning @c TRUE. | 39 This can also be used to cancel an outgoing message by returning @c TRUE. |
| 40 @note | 40 @note |
| 41 Make sure to free @a *message before you replace it! | 41 Make sure to free @a *message before you replace it! |
| 42 @param account The account the message is being displayed and sent on. | 42 @param account The account the message is being displayed and sent on. |
| 43 @param conv The conversation the message is being displayed and sent on. | 43 @param conv The conversation the message is being displayed and sent on. |
| 48 @signaldef wrote-im-msg | 48 @signaldef wrote-im-msg |
| 49 @signalproto | 49 @signalproto |
| 50 void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message); | 50 void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message); |
| 51 @endsignalproto | 51 @endsignalproto |
| 52 @signaldesc | 52 @signaldesc |
| 53 Emitted after a message is entered by the user, but before it is sent and displyed. | 53 Emitted after a message is entered by the user, but before it is sent and displyed. |
| 54 When sending an IM, the order that the im-msg callbacks will be called is: | 54 When sending an IM, the order that the im-msg callbacks will be called is: |
| 55 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, | 55 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, |
| 56 sending-im-msg, and finally sent-im-msg. | 56 sending-im-msg, and finally sent-im-msg. |
| 57 @param account The account the message was displayed on. | 57 @param account The account the message was displayed on. |
| 58 @param conv The conversation the message was displayed on. | 58 @param conv The conversation the message was displayed on. |
| 59 @param message The message that was displayed. | 59 @param message The message that was displayed. |
| 60 @endsignaldef | 60 @endsignaldef |
| 95 @signaldesc | 95 @signaldesc |
| 96 Emitted before sending an IM to a user. @a message is a pointer to the | 96 Emitted before sending an IM to a user. @a message is a pointer to the |
| 97 message string, so the plugin can replace the message before being sent. | 97 message string, so the plugin can replace the message before being sent. |
| 98 @note | 98 @note |
| 99 Make sure to free @a *message before you replace it! | 99 Make sure to free @a *message before you replace it! |
| 100 @param conv The account the message is being sent on. | 100 @param account The account the message is being sent on. |
| 101 @param receiver The username of the receiver. | 101 @param receiver The username of the receiver. |
| 102 @param message A pointer to the outgoing message. This can be modified. | 102 @param message A pointer to the outgoing message. This can be modified. |
| 103 @endsignaldef | 103 @endsignaldef |
| 104 | 104 |
| 105 @signaldef sent-im-msg | 105 @signaldef sent-im-msg |
| 135 @signaldef writing-chat-msg | 135 @signaldef writing-chat-msg |
| 136 @signalproto | 136 @signalproto |
| 137 gboolean (*writing_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message); | 137 gboolean (*writing_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message); |
| 138 @endsignalproto | 138 @endsignalproto |
| 139 @signaldesc | 139 @signaldesc |
| 140 Emitted before a message is displayed in a chat conversation or sent to | 140 Emitted before a message is displayed in a chat conversation or sent to |
| 141 a remote chat. @a message is a pointer to a string, so the plugin can | 141 a remote chat. @a message is a pointer to a string, so the plugin can |
| 142 replace the message that will be displayed along with the message that | 142 replace the message that will be displayed along with the message that |
| 143 will be sent. This can also be used to cancel an outgoing message by | 143 will be sent. This can also be used to cancel an outgoing message by |
| 144 returning @c TRUE. | 144 returning @c TRUE. |
| 145 @note | 145 @note |
| 146 Make sure to free @a *message before you replace it! | 146 Make sure to free @a *message before you replace it! |
| 147 @param account The account the message is being displayed and sent on. | 147 @param account The account the message is being displayed and sent on. |
| 148 @param conv The conversation the message is being displayed and sent on. | 148 @param conv The conversation the message is being displayed and sent on. |
| 153 @signaldef wrote-im-msg | 153 @signaldef wrote-im-msg |
| 154 @signalproto | 154 @signalproto |
| 155 void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message); | 155 void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message); |
| 156 @endsignalproto | 156 @endsignalproto |
| 157 @signaldesc | 157 @signaldesc |
| 158 Emitted after a message is entered by the user, but before it is sent and displyed. | 158 Emitted after a message is entered by the user, but before it is sent and displyed. |
| 159 When sending an IM, the order that the im-msg callbacks will be called is: | 159 When sending an IM, the order that the im-msg callbacks will be called is: |
| 160 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, | 160 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, |
| 161 sending-im-msg, and finally sent-im-msg. | 161 sending-im-msg, and finally sent-im-msg. |
| 162 @param account The account the message was displayed on. | 162 @param account The account the message was displayed on. |
| 163 @param conv The conversation the message was displayed on. | 163 @param conv The conversation the message was displayed on. |
| 164 @param message The message that was displayed. | 164 @param message The message that was displayed. |
| 165 @endsignaldef | 165 @endsignaldef |