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