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