Mercurial > pidgin.yaz
annotate doc/conversation-signals.dox @ 9944:e4a27c9aec4c
[gaim-migrate @ 10838]
with much rejoicing, and massive thanks to the efforts of Christian, and
all who have helped him, I present to you the incomplete status
rewrite!
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Fri, 03 Sep 2004 21:35:52 +0000 |
parents | 5e1c76f3d232 |
children | 60db14d54914 |
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, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
127 char **message, 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. |
8736 | 140 @param flags The message flags. |
6605 | 141 @endsignaldef |
142 | |
8999 | 143 @signaldef received-im-msg |
144 @signalproto | |
145 void (*received_im_msg)(GaimAccount *account, char *sender, | |
146 char *message, int flags); | |
147 @endsignalproto | |
148 @signaldesc | |
149 Emitted after an IM is received. | |
150 @param account The account the message was received on. | |
151 @param sender The username of the sender. | |
152 @param message The message that was sent. | |
153 @param flags The message flags. | |
154 @endsignaldef | |
155 | |
8078 | 156 @signaldef writing-chat-msg |
157 @signalproto | |
158 gboolean (*writing_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message); | |
159 @endsignalproto | |
160 @signaldesc | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
161 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
|
162 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
|
163 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
|
164 will be sent. This can also be used to cancel an outgoing message by |
8078 | 165 returning @c TRUE. |
166 @note | |
167 Make sure to free @a *message before you replace it! | |
168 @param account The account the message is being displayed and sent on. | |
169 @param conv The conversation the message is being displayed and sent on. | |
170 @param message A pointer to the message that will be displayed and sent. | |
171 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. | |
172 @endsignaldef | |
173 | |
8736 | 174 @signaldef wrote-chat-msg |
8078 | 175 @signalproto |
8736 | 176 void (*wrote_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message); |
8078 | 177 @endsignalproto |
178 @signaldesc | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
179 Emitted after a message is entered by the user, but before it is sent and displyed. |
8078 | 180 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
|
181 writing-im-msg, wrote-im-msg, displaying-im-msg, displayed-im-msg, sending-im-msg, |
8736 | 182 and finally sent-im-msg. |
8078 | 183 @param account The account the message was displayed on. |
184 @param conv The conversation the message was displayed on. | |
185 @param message The message that was displayed. | |
186 @endsignaldef | |
187 | |
6605 | 188 @signaldef displaying-chat-msg |
189 @signalproto | |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
190 gboolean (*displaying_chat_msg)(GaimAccount *account, GaimConversation *conv, char **message); |
6605 | 191 @endsignalproto |
192 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
193 Emitted just before a message is displayed in a chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
194 @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
|
195 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
|
196 a message by returning @c TRUE. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
197 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
198 Make sure to free @a *message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
199 @param account The account the message is being displayed on. |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
200 @param conv The conversation the message is being displayed on. |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
201 @param message A pointer to the message that will be displayed. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
202 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
6605 | 203 @endsignaldef |
204 | |
205 @signaldef displayed-chat-msg | |
206 @signalproto | |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
207 void (*displayed_chat_msg)(GaimAccount *account, GaimConversation *conv, const char *message); |
6605 | 208 @endsignalproto |
209 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
210 Emitted after a message is displayed in a chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
211 @param account The account the message was displayed on. |
6781
0489da496f33
[gaim-migrate @ 7320]
Christian Hammond <chipx86@chipx86.com>
parents:
6610
diff
changeset
|
212 @param conv The conversation the message was displayed on. |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
213 @param message The message that was displayed. |
6605 | 214 @endsignaldef |
215 | |
216 @signaldef sending-chat-msg | |
217 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
218 void (*sending_chat_msg)(GaimAccount *account, char **message, int id); |
6605 | 219 @endsignalproto |
220 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
221 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
|
222 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
|
223 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
224 Make sure to free @a *message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
225 @param account The account the message is being sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
226 @param message A pointer to the message that will be sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
227 @param id The ID of the chat. |
6605 | 228 @endsignaldef |
229 | |
230 @signaldef sent-chat-msg | |
231 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
232 void (*sent_chat_msg)(GaimAccount *account, const char *message, int id); |
6605 | 233 @endsignalproto |
234 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
235 Emitted after sending a message to a chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
236 @param account The account the message was sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
237 @param message The message that was sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
238 @param id The ID of the chat. |
6605 | 239 @endsignaldef |
240 | |
8999 | 241 @signaldef receiving-chat-msg |
6605 | 242 @signalproto |
8999 | 243 gboolean (*receiving_chat_msg)(GaimAccount *account, char **sender, |
7512
72a795d4b143
[gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents:
6838
diff
changeset
|
244 char **message, GaimConversation *conv); |
6605 | 245 @endsignalproto |
246 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
247 Emitted when a chat message is received. The callback can replace the |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
248 name of the sender or the messageby modifying the pointer to the |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
249 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
|
250 returning @c TRUE. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
251 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
252 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
|
253 @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
|
254 @param account The account the message was received on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
255 @param sender A pointer to the username of the sender. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
256 @param message A pointer to the message that was sent. |
7512
72a795d4b143
[gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents:
6838
diff
changeset
|
257 @param conv The chat conversation. |
6605 | 258 @endsignaldef |
259 | |
8999 | 260 @signaldef received-chat-msg |
261 @signalproto | |
262 void (*received_chat_msg)(GaimAccount *account, char *sender, | |
263 char *message, GaimConversation *conv); | |
264 @endsignalproto | |
265 @signaldesc | |
266 Emitted after a chat message is received. | |
267 @param account The account the message was received on. | |
268 @param sender The username of the sender. | |
269 @param message The message that was sent. | |
270 @param conv The chat conversation. | |
271 @endsignaldef | |
272 | |
6605 | 273 @signaldef conversation-switching |
274 @signalproto | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
275 void (*conversation_switching)(GaimConversation *old_conv, |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
276 GaimConversation *new_conv); |
6605 | 277 @endsignalproto |
278 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
279 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
|
280 another. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
281 @param old_conv The old active conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
282 @param new_conv The soon-to-be active conversation |
6605 | 283 @endsignaldef |
284 | |
285 @signaldef conversation-switched | |
286 @signalproto | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
287 void (*conversation_switched)(GaimConversation *old_conv, |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
288 GaimConversation *new_conv); |
6605 | 289 @endsignalproto |
290 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
291 Emitted when a window switched from one conversation to another. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
292 @param old_conv The old active conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
293 @param new_conv The now active conversation. |
6605 | 294 @endsignaldef |
295 | |
296 @signaldef conversation-created | |
297 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
298 void (*conversation_created)(GaimConversation *conv); |
6605 | 299 @endsignalproto |
300 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
301 Emitted when a new conversation is created. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
302 @param conv The new conversation. |
6605 | 303 @endsignaldef |
304 | |
305 @signaldef deleting-conversation | |
306 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
307 void (*deleting_conversation)(GaimConversation *conv); |
6605 | 308 @endsignalproto |
309 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
310 Emitted just before a conversation is to be destroyed. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
311 @param conv The conversation that's about to be destroyed. |
6605 | 312 @endsignaldef |
313 | |
314 @signaldef buddy-typing | |
315 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
316 void (*buddy_typing)(GaimConversation *conv); |
6605 | 317 @endsignalproto |
318 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
319 Emitted when a buddy starts typing in a conversation window. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
320 @param conv The IM conversation a buddy is typing in. |
6605 | 321 @endsignaldef |
322 | |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
323 @signaldef buddy-typing-stopped |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
324 @signalproto |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
325 void (*buddy_typing)(GaimConversation *conv); |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
326 @endsignalproto |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
327 @signaldesc |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
328 Emitted when a buddy stops typing in a conversation window. |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
329 @param conv The IM conversation a buddy is typing in. |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
330 @endsignaldef |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
331 |
6605 | 332 @signaldef chat-buddy-joining |
333 @signalproto | |
9587 | 334 gboolean (*chat_buddy_joining)(GaimConversation *conv, const char *name, |
9554 | 335 GaimConvChatBuddyFlags flags); |
6605 | 336 @endsignalproto |
337 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
338 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
|
339 users in the chat updates to include the new user. |
9587 | 340 @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
|
341 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
342 @param name The name of the user that is joining the conversation. |
9554 | 343 @param flags The flags of the user that is joining the conversation. |
6605 | 344 @endsignaldef |
345 | |
346 @signaldef chat-buddy-joined | |
347 @signalproto | |
9554 | 348 void (*chat_buddy_joined)(GaimConversation *conv, const char *name, |
349 GaimConvChatBuddyFlags flags); | |
6605 | 350 @endsignalproto |
351 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
352 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
|
353 @param conv The chat conversation. |
9554 | 354 @param name The name of the user that has joined the conversation. |
355 @param flags The flags of the user that has joined the conversation. | |
356 @endsignaldef | |
357 | |
358 @signaldef chat-buddy-flags | |
359 @signalproto | |
360 void (*chat_buddy_flags)(GaimConversation *conv, const char *name, | |
361 GaimConvChatBuddyFlags oldflags, | |
362 GaimConvChatBuddyFlags newflags); | |
363 @endsignalproto | |
364 @signaldesc | |
365 Emitted when a user in a chat changes flags. | |
366 @param conv The chat conversation. | |
367 @param name The name of the user. | |
368 @param oldflags The old flags. | |
369 @param newflags The new flags. | |
6605 | 370 @endsignaldef |
371 | |
372 @signaldef chat-buddy-leaving | |
373 @signalproto | |
9587 | 374 gboolean (*chat_buddy_leaving)(GaimConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
375 const char *reason); |
6605 | 376 @endsignalproto |
377 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
378 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
|
379 This may include an optional reason why the user is leaving. |
9587 | 380 @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
|
381 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
382 @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
|
383 @param reason The optional reason why the user is leaving. |
6605 | 384 @endsignaldef |
385 | |
386 @signaldef chat-buddy-left | |
387 @signalproto | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
388 void (*chat_buddy_left)(GaimConversation *conv, const char *name, |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
389 const char *reason); |
6605 | 390 @endsignalproto |
391 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
392 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
|
393 This may include an optional reason why the user is leaving. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
394 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
395 @param name The name of the user that left the chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
396 @param reason The optional reason why the user left the chat. |
6605 | 397 @endsignaldef |
398 | |
399 @signaldef chat-inviting-user | |
400 @signalproto | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
401 void (*chat_inviting_user)(GaimConversation *conv, const char *name, |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
402 char **invite_message); |
6605 | 403 @endsignalproto |
404 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
405 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
|
406 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
|
407 the invite message. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
408 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
409 Make sure to free @a *invite_message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
410 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
411 @param name The name of the user being invited. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
412 @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
|
413 invited. |
6605 | 414 @endsignaldef |
415 | |
416 @signaldef chat-invited-user | |
417 @signalproto | |
6610
3beb00af2e1a
[gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents:
6609
diff
changeset
|
418 void (*chat_invited_user)(GaimConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
419 const char *invite_message); |
6605 | 420 @endsignalproto |
421 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
422 Emitted when a user invited another user to a chat. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
423 @param conv The chat conversation. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
424 @param conv The name of the user that was invited. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
425 @param invite_message The message to be sent to the user when invited. |
6605 | 426 @endsignaldef |
427 | |
428 @signaldef chat-invited | |
429 @signalproto | |
6610
3beb00af2e1a
[gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents:
6609
diff
changeset
|
430 void (*chat_invited)(GaimAccount *account, const char *inviter, |
9514 | 431 const char *chat, const char *invite_message |
432 const GHastTable *components); | |
6605 | 433 @endsignalproto |
434 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
435 Emitted when an account was invited to a chat. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
436 @param account The account being invited. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
437 @param inviter The username of the person inviting the account. |
9484 | 438 @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
|
439 @param invite_message The optional invite message. |
9514 | 440 @param components The components necessary if you want to call |
441 serv_join_chat | |
6605 | 442 @endsignaldef |
443 | |
444 @signaldef chat-joined | |
445 @signalproto | |
6610
3beb00af2e1a
[gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents:
6609
diff
changeset
|
446 void (*chat_joined)(GaimConversation *conv); |
6605 | 447 @endsignalproto |
448 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
449 Emitted when an account joins a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
450 @param conv The conversation that joined the chat room. |
6605 | 451 @endsignaldef |
452 | |
453 @signaldef chat-left | |
454 @signalproto | |
6610
3beb00af2e1a
[gaim-migrate @ 7134]
Christian Hammond <chipx86@chipx86.com>
parents:
6609
diff
changeset
|
455 void (*chat_left)(GaimConversation *conv); |
6605 | 456 @endsignalproto |
457 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
458 Emitted when an account leaves a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
459 @param conv The conversation that left the chat room. |
6605 | 460 @endsignaldef |
461 | |
9517 | 462 @signaldef chat-topic-changed |
463 @signalproto | |
464 void (*chat_topic_changed)(GaimConversation *conv, const char *who, const char *topic); | |
465 @endsignalproto | |
466 @signaldesc | |
467 Emitted when the topic is changed in a chat. | |
468 @param conv The conversation whose topic changed. | |
469 @param who The name of the person that changed the topic. | |
470 @param topic The new topic. | |
471 @endsignaldef | |
472 | |
6605 | 473 */ |
474 // vim: syntax=c tw=75 et |