Mercurial > pidgin.yaz
annotate doc/conversation-signals.dox @ 12070:e4666705944b
[gaim-migrate @ 14365]
patches [ 1353462 ] account-disabled/enabled signals, use them in account dialog
and [ 1355690 ] Add/remove statusbox when accounts are enabled/disabled
some parts of the first one didn't apply, but they were doc changes, so
i figured charkins could diff them.
committer: Tailor Script <tailor@pidgin.im>
author | Tim Ringenbach <marv@pidgin.im> |
---|---|
date | Sun, 13 Nov 2005 03:45:16 +0000 |
parents | 1ec93dd2f359 |
children | 366326fa9cb4 |
rev | line source |
---|---|
6605 | 1 /** @page conversation-signals Conversation Signals |
2 | |
3 @signals | |
8736 | 4 @signal writing-im-msg |
5 @signal wrote-im-msg | |
6605 | 6 @signal displaying-im-msg |
7 @signal displayed-im-msg | |
8 @signal sending-im-msg | |
9 @signal sent-im-msg | |
8999 | 10 @signal receiving-im-msg |
6605 | 11 @signal received-im-msg |
8736 | 12 @signal writing-chat-msg |
13 @signal wrote-chat-msg | |
6605 | 14 @signal displaying-chat-msg |
15 @signal displayed-chat-msg | |
16 @signal sending-chat-msg | |
17 @signal sent-chat-msg | |
8999 | 18 @signal receiving-chat-msg |
6605 | 19 @signal received-chat-msg |
20 @signal conversation-switching | |
21 @signal conversation-switched | |
22 @signal conversation-created | |
12053 | 23 @signal conversation-updated |
6605 | 24 @signal deleting-conversation |
25 @signal buddy-typing | |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
26 @signal buddy-typing-stopped |
6605 | 27 @signal chat-buddy-joining |
28 @signal chat-buddy-joined | |
12053 | 29 @signal chat-buddy-flags |
6605 | 30 @signal chat-buddy-leaving |
31 @signal chat-buddy-left | |
32 @signal chat-inviting-user | |
33 @signal chat-invited-user | |
34 @signal chat-invited | |
35 @signal chat-joined | |
36 @signal chat-left | |
9517 | 37 @signal chat-topic-changed |
6605 | 38 @endsignals |
39 | |
8078 | 40 @signaldef writing-im-msg |
41 @signalproto | |
42 gboolean (*writing_im_msg)(GaimAccount *account, GaimConversation *conv, char **message); | |
43 @endsignalproto | |
44 @signaldesc | |
45 Emitted before a message is displayed in an IM conversation or sent to a remote user. | |
46 @a message is a pointer to a string, so the plugin can replace the | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
47 message that will be displayed along with the message that will be sent. |
8078 | 48 This can also be used to cancel an outgoing message by returning @c TRUE. |
49 @note | |
50 Make sure to free @a *message before you replace it! | |
51 @param account The account the message is being displayed and sent on. | |
52 @param conv The conversation the message is being displayed and sent on. | |
53 @param message A pointer to the message that will be displayed and sent. | |
54 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. | |
55 @endsignaldef | |
56 | |
57 @signaldef wrote-im-msg | |
58 @signalproto | |
59 void (*wrote_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message); | |
60 @endsignalproto | |
61 @signaldesc | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
62 Emitted after a message is entered by the user, but before it is sent and displyed. |
8078 | 63 When sending an IM, the order that the im-msg callbacks will be called is: |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
64 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, |
8736 | 65 and finally sent-im-msg. |
8078 | 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 | |
6605 | 71 @signaldef displaying-im-msg |
72 @signalproto | |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
73 gboolean (*displaying_im_msg)(GaimAccount *account, GaimConversation *conv, char **message); |
6605 | 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! | |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
82 @param account The account the message is being displayed on. |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
83 @param conv The conversation the message is being displayed on. |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
84 @param message A pointer to the message that will be displayed. |
6605 | 85 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
86 @endsignaldef | |
87 | |
88 @signaldef displayed-im-msg | |
89 @signalproto | |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
90 void (*displayed_im_msg)(GaimAccount *account, GaimConversation *conv, const char *message); |
6605 | 91 @endsignalproto |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
92 @signaldesc |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
93 Emitted after a message is displayed in an IM conversation. |
6605 | 94 @param account The account the message was displayed on. |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
95 @param conv The conversation the message was displayed on. |
6605 | 96 @param message The message that was displayed. |
97 @endsignaldef | |
98 | |
99 @signaldef sending-im-msg | |
100 @signalproto | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
101 void (*sending_im_msg)(GaimAccount *account, const char *receiver, |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
102 char **message); |
6605 | 103 @endsignalproto |
104 @signaldesc | |
105 Emitted before sending an IM to a user. @a message is a pointer to the | |
106 message string, so the plugin can replace the message before being sent. | |
107 @note | |
108 Make sure to free @a *message before you replace it! | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
109 @param account The account the message is being sent on. |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
110 @param receiver The username of the receiver. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
111 @param message A pointer to the outgoing message. This can be modified. |
6605 | 112 @endsignaldef |
113 | |
114 @signaldef sent-im-msg | |
115 @signalproto | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
116 void (*sent_im_msg)(GaimAccount *account, const char *receiver, |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
117 const char *message); |
6605 | 118 @endsignalproto |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
119 @signaldesc |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
120 Emitted after sending an IM to a user. |
6605 | 121 @param account The account the message was sent on. |
122 @param receiver The username of the receiver. | |
123 @param message The message that was sent. | |
124 @endsignaldef | |
125 | |
8999 | 126 @signaldef receiving-im-msg |
6605 | 127 @signalproto |
8999 | 128 gboolean (*receiving_im_msg)(GaimAccount *account, char **sender, |
10104 | 129 char **message, GaimConversation *conv, int *flags); |
6605 | 130 @endsignalproto |
131 @signaldesc | |
132 Emitted when an IM is received. The callback can replace the name of the | |
133 sender, the message, or the flags by modifying the pointer to the | |
134 strings and integer. This can also be used to cancel a message by | |
135 returning @c TRUE. | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
136 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
137 Make sure to free @a *sender and @a *message before you replace them! |
6605 | 138 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
139 @param account The account the message was received on. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
140 @param sender A pointer to the username of the sender. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
141 @param message A pointer to the message that was sent. |
10104 | 142 @param conv The IM conversation. |
143 @param flags A pointer to the IM message flags. | |
6605 | 144 @endsignaldef |
145 | |
8999 | 146 @signaldef received-im-msg |
147 @signalproto | |
10104 | 148 void (*received_im_msg)(GaimAccount *account, char *sender, char *message, |
149 GaimConversation *conv, int flags); | |
8999 | 150 @endsignalproto |
151 @signaldesc | |
152 Emitted after an IM is received. | |
153 @param account The account the message was received on. | |
154 @param sender The username of the sender. | |
155 @param message The message that was sent. | |
10104 | 156 @param conv The IM conversation. |
157 @param flags The IM message flags. | |
8999 | 158 @endsignaldef |
159 | |
8078 | 160 @signaldef writing-chat-msg |
161 @signalproto | |
162 gboolean (*writing_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message); | |
163 @endsignalproto | |
164 @signaldesc | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
165 Emitted before a message is displayed in a chat conversation or sent to |
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
166 a remote chat. @a message is a pointer to a string, so the plugin can |
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
167 replace the message that will be displayed along with the message that |
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
168 will be sent. This can also be used to cancel an outgoing message by |
8078 | 169 returning @c TRUE. |
170 @note | |
171 Make sure to free @a *message before you replace it! | |
172 @param account The account the message is being displayed and sent on. | |
173 @param conv The conversation the message is being displayed and sent on. | |
174 @param message A pointer to the message that will be displayed and sent. | |
175 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. | |
176 @endsignaldef | |
177 | |
8736 | 178 @signaldef wrote-chat-msg |
8078 | 179 @signalproto |
8736 | 180 void (*wrote_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message); |
8078 | 181 @endsignalproto |
182 @signaldesc | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
183 Emitted after a message is entered by the user, but before it is sent and displyed. |
8078 | 184 When sending an IM, the order that the im-msg callbacks will be called is: |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
185 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, |
8736 | 186 and finally sent-im-msg. |
8078 | 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 | |
6605 | 192 @signaldef displaying-chat-msg |
193 @signalproto | |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
194 gboolean (*displaying_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message); |
6605 | 195 @endsignalproto |
196 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
197 Emitted just before a message is displayed in a chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
198 @a message is a pointer to a string, so the plugin can replace the |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
199 message that will be displayed. This can also be used to cancel displaying |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
200 a message by returning @c TRUE. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
201 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
202 Make sure to free @a *message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
203 @param account The account the message is being displayed on. |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
204 @param conv The conversation the message is being displayed on. |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
205 @param message A pointer to the message that will be displayed. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
206 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
6605 | 207 @endsignaldef |
208 | |
209 @signaldef displayed-chat-msg | |
210 @signalproto | |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
211 void (*displayed_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message); |
6605 | 212 @endsignalproto |
213 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
214 Emitted after a message is displayed in a chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
215 @param account The account the message was displayed on. |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
216 @param conv The conversation the message was displayed on. |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
217 @param message The message that was displayed. |
6605 | 218 @endsignaldef |
219 | |
220 @signaldef sending-chat-msg | |
221 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
222 void (*sending_chat_msg)(GaimAccount *account, char **message, int id); |
6605 | 223 @endsignalproto |
224 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
225 Emitted before sending a message to a chat. @a message is a pointer to the |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
226 message string, so the plugin can replace the message before being sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
227 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
228 Make sure to free @a *message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
229 @param account The account the message is being sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
230 @param message A pointer to the message that will be sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
231 @param id The ID of the chat. |
6605 | 232 @endsignaldef |
233 | |
234 @signaldef sent-chat-msg | |
235 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
236 void (*sent_chat_msg)(GaimAccount *account, const char *message, int id); |
6605 | 237 @endsignalproto |
238 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
239 Emitted after sending a message to a chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
240 @param account The account the message was sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
241 @param message The message that was sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
242 @param id The ID of the chat. |
6605 | 243 @endsignaldef |
244 | |
8999 | 245 @signaldef receiving-chat-msg |
6605 | 246 @signalproto |
8999 | 247 gboolean (*receiving_chat_msg)(GaimAccount *account, char **sender, |
10104 | 248 char **message, GaimConversation *conv, int *flags); |
6605 | 249 @endsignalproto |
250 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
251 Emitted when a chat message is received. The callback can replace the |
10104 | 252 name of the sender, the message, or the flags by modifying the pointer to the |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
253 strings. This can also be used to cancel displaying a message by |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
254 returning @c TRUE. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
255 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
256 Make sure to free @a *sender and @a *message before you replace them! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
257 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
258 @param account The account the message was received on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
259 @param sender A pointer to the username of the sender. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
260 @param message A pointer to the message that was sent. |
7512
72a795d4b143
[gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents:
6838
diff
changeset
|
261 @param conv The chat conversation. |
10104 | 262 @param flags A pointer to the chat message flags |
6605 | 263 @endsignaldef |
264 | |
8999 | 265 @signaldef received-chat-msg |
266 @signalproto | |
10104 | 267 void (*received_chat_msg)(GaimAccount *account, char *sender, char *message, |
268 GaimConversation *conv, int flags); | |
8999 | 269 @endsignalproto |
270 @signaldesc | |
271 Emitted after a chat message is received. | |
272 @param account The account the message was received on. | |
273 @param sender The username of the sender. | |
274 @param message The message that was sent. | |
275 @param conv The chat conversation. | |
10104 | 276 @param flags The chat message flags. |
8999 | 277 @endsignaldef |
278 | |
6605 | 279 @signaldef conversation-switching |
280 @signalproto | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
281 void (*conversation_switching)(GaimConversation *old_conv, |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
282 GaimConversation *new_conv); |
6605 | 283 @endsignalproto |
284 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
285 Emitted when a window is about to switch from one conversation to |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
286 another. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
287 @param old_conv The old active conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
288 @param new_conv The soon-to-be active conversation |
6605 | 289 @endsignaldef |
290 | |
291 @signaldef conversation-switched | |
292 @signalproto | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
293 void (*conversation_switched)(GaimConversation *old_conv, |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
294 GaimConversation *new_conv); |
6605 | 295 @endsignalproto |
296 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
297 Emitted when a window switched from one conversation to another. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
298 @param old_conv The old active conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
299 @param new_conv The now active conversation. |
6605 | 300 @endsignaldef |
301 | |
302 @signaldef conversation-created | |
303 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
304 void (*conversation_created)(GaimConversation *conv); |
6605 | 305 @endsignalproto |
306 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
307 Emitted when a new conversation is created. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
308 @param conv The new conversation. |
6605 | 309 @endsignaldef |
310 | |
12053 | 311 @signaldef conversation-updated |
312 @signalproto | |
313 void (*conversation_updated)(GaimConversation *conv, | |
314 GaimConvUpdateType type); | |
315 @endsignalproto | |
316 @signaldesc | |
317 Emitted when a conversation is updated. | |
318 @param conv The conversation that was updated. | |
319 @param type The type of update that was made. | |
320 @endsignaldef | |
321 | |
6605 | 322 @signaldef deleting-conversation |
323 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
324 void (*deleting_conversation)(GaimConversation *conv); |
6605 | 325 @endsignalproto |
326 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
327 Emitted just before a conversation is to be destroyed. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
328 @param conv The conversation that's about to be destroyed. |
6605 | 329 @endsignaldef |
330 | |
331 @signaldef buddy-typing | |
332 @signalproto | |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
333 void (*buddy_typing)(GaimAccount *account, const char *name); |
6605 | 334 @endsignalproto |
335 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
336 Emitted when a buddy starts typing in a conversation window. |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
337 @param account The account of the user which is typing. |
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
338 @param name The name of the user which is typing. |
6605 | 339 @endsignaldef |
340 | |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
341 @signaldef buddy-typing-stopped |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
342 @signalproto |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
343 void (*buddy_typing_stopped)(GaimAccount *account, const char *name); |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
344 @endsignalproto |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
345 @signaldesc |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
346 Emitted when a buddy stops typing in a conversation window. |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
347 @param account The account of the user which stopped typing. |
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
348 @param name The name of the user which stopped typing. |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
349 @endsignaldef |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
350 |
6605 | 351 @signaldef chat-buddy-joining |
352 @signalproto | |
9587 | 353 gboolean (*chat_buddy_joining)(GaimConversation *conv, const char *name, |
9554 | 354 GaimConvChatBuddyFlags flags); |
6605 | 355 @endsignalproto |
356 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
357 Emitted when a buddy is joining a chat, before the list of |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
358 users in the chat updates to include the new user. |
9587 | 359 @return @c TRUE if the join should be hidden, or @c FALSE otherwise. |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
360 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
361 @param name The name of the user that is joining the conversation. |
9554 | 362 @param flags The flags of the user that is joining the conversation. |
6605 | 363 @endsignaldef |
364 | |
365 @signaldef chat-buddy-joined | |
366 @signalproto | |
9554 | 367 void (*chat_buddy_joined)(GaimConversation *conv, const char *name, |
368 GaimConvChatBuddyFlags flags); | |
6605 | 369 @endsignalproto |
370 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
371 Emitted when a buddy joined a chat, after the users list is updated. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
372 @param conv The chat conversation. |
9554 | 373 @param name The name of the user that has joined the conversation. |
374 @param flags The flags of the user that has joined the conversation. | |
375 @endsignaldef | |
376 | |
377 @signaldef chat-buddy-flags | |
378 @signalproto | |
379 void (*chat_buddy_flags)(GaimConversation *conv, const char *name, | |
380 GaimConvChatBuddyFlags oldflags, | |
381 GaimConvChatBuddyFlags newflags); | |
382 @endsignalproto | |
383 @signaldesc | |
384 Emitted when a user in a chat changes flags. | |
385 @param conv The chat conversation. | |
386 @param name The name of the user. | |
387 @param oldflags The old flags. | |
388 @param newflags The new flags. | |
6605 | 389 @endsignaldef |
390 | |
391 @signaldef chat-buddy-leaving | |
392 @signalproto | |
9587 | 393 gboolean (*chat_buddy_leaving)(GaimConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
394 const char *reason); |
6605 | 395 @endsignalproto |
396 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
397 Emitted when a user is leaving a chat, before the user list is updated. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
398 This may include an optional reason why the user is leaving. |
9587 | 399 @return @c TRUE if the leave should be hidden, or @c FALSE otherwise. |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
400 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
401 @param name The name of the user that is leaving the chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
402 @param reason The optional reason why the user is leaving. |
6605 | 403 @endsignaldef |
404 | |
405 @signaldef chat-buddy-left | |
406 @signalproto | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
407 void (*chat_buddy_left)(GaimConversation *conv, const char *name, |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
408 const char *reason); |
6605 | 409 @endsignalproto |
410 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
411 Emitted when a user leaves a chat, after the user list is updated. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
412 This may include an optional reason why the user is leaving. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
413 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
414 @param name The name of the user that left the chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
415 @param reason The optional reason why the user left the chat. |
6605 | 416 @endsignaldef |
417 | |
418 @signaldef chat-inviting-user | |
419 @signalproto | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
420 void (*chat_inviting_user)(GaimConversation *conv, const char *name, |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
421 char **invite_message); |
6605 | 422 @endsignalproto |
423 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
424 Emitted when a user is being invited to the chat. The callback can |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
425 replace the invite message to the invitee by modifying the pointer to |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
426 the invite message. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
427 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
428 Make sure to free @a *invite_message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
429 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
430 @param name The name of the user being invited. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
431 @param invite_message A pointer to the reason why a user is being |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
432 invited. |
6605 | 433 @endsignaldef |
434 | |
435 @signaldef chat-invited-user | |
436 @signalproto | |
6610
3beb00af2e1a
[gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents:
6609
diff
changeset
|
437 void (*chat_invited_user)(GaimConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
438 const char *invite_message); |
6605 | 439 @endsignalproto |
440 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
441 Emitted when a user invited another user to a chat. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
442 @param conv The chat conversation. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
443 @param conv The name of the user that was invited. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
444 @param invite_message The message to be sent to the user when invited. |
6605 | 445 @endsignaldef |
446 | |
447 @signaldef chat-invited | |
448 @signalproto | |
11064
e4459e8ccfb5
[gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents:
10104
diff
changeset
|
449 gint (*chat_invited)(GaimAccount *account, const char *inviter, |
9514 | 450 const char *chat, const char *invite_message |
11474
7e9635b73ed6
[gaim-migrate @ 13715]
Gary Kramlich <grim@reaperworld.com>
parents:
11064
diff
changeset
|
451 const GHashTable *components); |
6605 | 452 @endsignalproto |
453 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
454 Emitted when an account was invited to a chat. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
455 @param account The account being invited. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
456 @param inviter The username of the person inviting the account. |
9484 | 457 @param chat The name of the chat you're being invited to. |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
458 @param invite_message The optional invite message. |
9514 | 459 @param components The components necessary if you want to call |
460 serv_join_chat | |
11064
e4459e8ccfb5
[gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents:
10104
diff
changeset
|
461 @return Less than zero if the invitation should be rejected, greater than |
e4459e8ccfb5
[gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents:
10104
diff
changeset
|
462 zero if the invitation should be accepted. If zero is returned, the |
e4459e8ccfb5
[gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents:
10104
diff
changeset
|
463 default behavior will be maintained: the user will be prompted. |
6605 | 464 @endsignaldef |
465 | |
466 @signaldef chat-joined | |
467 @signalproto | |
6610
3beb00af2e1a
[gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents:
6609
diff
changeset
|
468 void (*chat_joined)(GaimConversation *conv); |
6605 | 469 @endsignalproto |
470 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
471 Emitted when an account joins a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
472 @param conv The conversation that joined the chat room. |
6605 | 473 @endsignaldef |
474 | |
475 @signaldef chat-left | |
476 @signalproto | |
6610
3beb00af2e1a
[gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents:
6609
diff
changeset
|
477 void (*chat_left)(GaimConversation *conv); |
6605 | 478 @endsignalproto |
479 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
480 Emitted when an account leaves a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
481 @param conv The conversation that left the chat room. |
6605 | 482 @endsignaldef |
483 | |
9517 | 484 @signaldef chat-topic-changed |
485 @signalproto | |
486 void (*chat_topic_changed)(GaimConversation *conv, const char *who, const char *topic); | |
487 @endsignalproto | |
488 @signaldesc | |
489 Emitted when the topic is changed in a chat. | |
490 @param conv The conversation whose topic changed. | |
491 @param who The name of the person that changed the topic. | |
492 @param topic The new topic. | |
493 @endsignaldef | |
494 | |
6605 | 495 */ |
496 // vim: syntax=c tw=75 et |