Mercurial > pidgin
comparison doc/conversation-signals.dox @ 12639:366326fa9cb4
[gaim-migrate @ 14975]
SF Patch #1323534 from Sadrul
"There is a documented signal `conversation-switched',
which never gets emitted. This patch emits this signal
when a conversation is switched. This signal can be
used by plugins that may want to deal with menu-items /
menu-tray items etc."
"The conversation-switched signals is moved to gtkconv,
-switching signal is removed. Changelog.API and doc/.dox
files are updated. I have included the changes in
displaying-signals in the dox-files as well."
Also, I added a cast to the code from my last commit to suppress a warning. I wish C knew about object oriented inheritance.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Fri, 23 Dec 2005 05:13:52 +0000 |
parents | 1ec93dd2f359 |
children | 49b2347863b2 |
comparison
equal
deleted
inserted
replaced
12638:7a2a2ca48703 | 12639:366326fa9cb4 |
---|---|
1 /** @page conversation-signals Conversation Signals | 1 /** @page conversation-signals Conversation Signals |
2 | 2 |
3 @signals | 3 @signals |
4 @signal writing-im-msg | 4 @signal writing-im-msg |
5 @signal wrote-im-msg | 5 @signal wrote-im-msg |
6 @signal displaying-im-msg | |
7 @signal displayed-im-msg | |
8 @signal sending-im-msg | 6 @signal sending-im-msg |
9 @signal sent-im-msg | 7 @signal sent-im-msg |
10 @signal receiving-im-msg | 8 @signal receiving-im-msg |
11 @signal received-im-msg | 9 @signal received-im-msg |
12 @signal writing-chat-msg | 10 @signal writing-chat-msg |
13 @signal wrote-chat-msg | 11 @signal wrote-chat-msg |
14 @signal displaying-chat-msg | |
15 @signal displayed-chat-msg | |
16 @signal sending-chat-msg | 12 @signal sending-chat-msg |
17 @signal sent-chat-msg | 13 @signal sent-chat-msg |
18 @signal receiving-chat-msg | 14 @signal receiving-chat-msg |
19 @signal received-chat-msg | 15 @signal received-chat-msg |
20 @signal conversation-switching | |
21 @signal conversation-switched | |
22 @signal conversation-created | 16 @signal conversation-created |
23 @signal conversation-updated | 17 @signal conversation-updated |
24 @signal deleting-conversation | 18 @signal deleting-conversation |
25 @signal buddy-typing | 19 @signal buddy-typing |
26 @signal buddy-typing-stopped | 20 @signal buddy-typing-stopped |
59 void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message); | 53 void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message); |
60 @endsignalproto | 54 @endsignalproto |
61 @signaldesc | 55 @signaldesc |
62 Emitted after a message is entered by the user, but before it is sent and displyed. | 56 Emitted after a message is entered by the user, but before it is sent and displyed. |
63 When sending an IM, the order that the im-msg callbacks will be called is: | 57 When sending an IM, the order that the im-msg callbacks will be called is: |
64 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, | 58 writing-im-msg, wrote-im-msg, sending-im-msg, and finally sent-im-msg. |
65 and finally sent-im-msg. | |
66 @param account The account the message was displayed on. | |
67 @param conv The conversation the message was displayed on. | |
68 @param message The message that was displayed. | |
69 @endsignaldef | |
70 | |
71 @signaldef displaying-im-msg | |
72 @signalproto | |
73 gboolean (*displaying_im_msg)(GaimAccount *account, GaimConversation *conv, char **message); | |
74 @endsignalproto | |
75 @signaldesc | |
76 Emitted just before a message is displayed in an IM conversation. | |
77 @a message is a pointer to a string, so the plugin can replace the | |
78 message that will be displayed. This can also be used to cancel displaying | |
79 a message by returning @c TRUE. | |
80 @note | |
81 Make sure to free @a *message before you replace it! | |
82 @param account The account the message is being displayed on. | |
83 @param conv The conversation the message is being displayed on. | |
84 @param message A pointer to the message that will be displayed. | |
85 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. | |
86 @endsignaldef | |
87 | |
88 @signaldef displayed-im-msg | |
89 @signalproto | |
90 void (*displayed_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message); | |
91 @endsignalproto | |
92 @signaldesc | |
93 Emitted after a message is displayed in an IM conversation. | |
94 @param account The account the message was displayed on. | 59 @param account The account the message was displayed on. |
95 @param conv The conversation the message was displayed on. | 60 @param conv The conversation the message was displayed on. |
96 @param message The message that was displayed. | 61 @param message The message that was displayed. |
97 @endsignaldef | 62 @endsignaldef |
98 | 63 |
180 void (*wrote_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message); | 145 void (*wrote_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message); |
181 @endsignalproto | 146 @endsignalproto |
182 @signaldesc | 147 @signaldesc |
183 Emitted after a message is entered by the user, but before it is sent and displyed. | 148 Emitted after a message is entered by the user, but before it is sent and displyed. |
184 When sending an IM, the order that the im-msg callbacks will be called is: | 149 When sending an IM, the order that the im-msg callbacks will be called is: |
185 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, | 150 writing-chat-msg, wrote-chat-msg, sending-chat-msg, and finally |
186 and finally sent-im-msg. | 151 sent-chat-msg. |
187 @param account The account the message was displayed on. | |
188 @param conv The conversation the message was displayed on. | |
189 @param message The message that was displayed. | |
190 @endsignaldef | |
191 | |
192 @signaldef displaying-chat-msg | |
193 @signalproto | |
194 gboolean (*displaying_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message); | |
195 @endsignalproto | |
196 @signaldesc | |
197 Emitted just before a message is displayed in a chat. | |
198 @a message is a pointer to a string, so the plugin can replace the | |
199 message that will be displayed. This can also be used to cancel displaying | |
200 a message by returning @c TRUE. | |
201 @note | |
202 Make sure to free @a *message before you replace it! | |
203 @param account The account the message is being displayed on. | |
204 @param conv The conversation the message is being displayed on. | |
205 @param message A pointer to the message that will be displayed. | |
206 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. | |
207 @endsignaldef | |
208 | |
209 @signaldef displayed-chat-msg | |
210 @signalproto | |
211 void (*displayed_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message); | |
212 @endsignalproto | |
213 @signaldesc | |
214 Emitted after a message is displayed in a chat conversation. | |
215 @param account The account the message was displayed on. | 152 @param account The account the message was displayed on. |
216 @param conv The conversation the message was displayed on. | 153 @param conv The conversation the message was displayed on. |
217 @param message The message that was displayed. | 154 @param message The message that was displayed. |
218 @endsignaldef | 155 @endsignaldef |
219 | 156 |
272 @param account The account the message was received on. | 209 @param account The account the message was received on. |
273 @param sender The username of the sender. | 210 @param sender The username of the sender. |
274 @param message The message that was sent. | 211 @param message The message that was sent. |
275 @param conv The chat conversation. | 212 @param conv The chat conversation. |
276 @param flags The chat message flags. | 213 @param flags The chat message flags. |
277 @endsignaldef | |
278 | |
279 @signaldef conversation-switching | |
280 @signalproto | |
281 void (*conversation_switching)(GaimConversation *old_conv, | |
282 GaimConversation *new_conv); | |
283 @endsignalproto | |
284 @signaldesc | |
285 Emitted when a window is about to switch from one conversation to | |
286 another. | |
287 @param old_conv The old active conversation. | |
288 @param new_conv The soon-to-be active conversation | |
289 @endsignaldef | |
290 | |
291 @signaldef conversation-switched | |
292 @signalproto | |
293 void (*conversation_switched)(GaimConversation *old_conv, | |
294 GaimConversation *new_conv); | |
295 @endsignalproto | |
296 @signaldesc | |
297 Emitted when a window switched from one conversation to another. | |
298 @param old_conv The old active conversation. | |
299 @param new_conv The now active conversation. | |
300 @endsignaldef | 214 @endsignaldef |
301 | 215 |
302 @signaldef conversation-created | 216 @signaldef conversation-created |
303 @signalproto | 217 @signalproto |
304 void (*conversation_created)(GaimConversation *conv); | 218 void (*conversation_created)(GaimConversation *conv); |