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