Mercurial > pidgin
annotate doc/conversation-signals.dox @ 6608:bc219e9efb9a
[gaim-migrate @ 7132]
This is the last bit of documentation I'm doing tonight. I might do some
tomorrow, but no promises.. school starts Monday.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Sun, 24 Aug 2003 06:59:35 +0000 |
parents | 34eaa941ecd6 |
children | d470295a4945 |
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 | |
19 @signal chat-buddy-joining | |
20 @signal chat-buddy-joined | |
21 @signal chat-buddy-leaving | |
22 @signal chat-buddy-left | |
23 @signal chat-inviting-user | |
24 @signal chat-invited-user | |
25 @signal chat-invited | |
26 @signal chat-joined | |
27 @signal chat-left | |
28 @endsignals | |
29 | |
30 @signaldef displaying-im-msg | |
31 @signalproto | |
32 gboolean (*displaying_im_msg)(GaimAccount *account, char **message); | |
33 @endsignalproto | |
34 @signaldesc | |
35 Emitted just before a message is displayed in an IM conversation. | |
36 @a message is a pointer to a string, so the plugin can replace the | |
37 message that will be displayed. This can also be used to cancel displaying | |
38 a message by returning @c TRUE. | |
39 @note | |
40 Make sure to free @a *message before you replace it! | |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
41 @param account The account the message is being displayed on. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
42 @param message A pointer to the message that will be displayed. |
6605 | 43 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
44 @endsignaldef | |
45 | |
46 @signaldef displayed-im-msg | |
47 @signalproto | |
48 void (*displayed_im_msg)(GaimAccount *account, const char *message); | |
49 @endsignalproto | |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
50 @signaldesc |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
51 Emitted after a message is displayed in an IM conversation. |
6605 | 52 @param account The account the message was displayed on. |
53 @param message The message that was displayed. | |
54 @endsignaldef | |
55 | |
56 @signaldef sending-im-msg | |
57 @signalproto | |
58 void (*sending_im_msg)(GaimAccount *account, const char *receiver, char **message); | |
59 @endsignalproto | |
60 @signaldesc | |
61 Emitted before sending an IM to a user. @a message is a pointer to the | |
62 message string, so the plugin can replace the message before being sent. | |
63 @note | |
64 Make sure to free @a *message before you replace it! | |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
65 @param conv The account the message is being sent on. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
66 @param receiver The username of the receiver. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
67 @param message A pointer to the outgoing message. This can be modified. |
6605 | 68 @endsignaldef |
69 | |
70 @signaldef sent-im-msg | |
71 @signalproto | |
72 void (*sent_im_msg)(GaimAccount *account, const char *receiver, const char *message); | |
73 @endsignalproto | |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
74 @signaldesc |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
75 Emitted after sending an IM to a user. |
6605 | 76 @param account The account the message was sent on. |
77 @param receiver The username of the receiver. | |
78 @param message The message that was sent. | |
79 @endsignaldef | |
80 | |
81 @signaldef received-im-msg | |
82 @signalproto | |
83 gboolean (*received_im_msg)(GaimAccount *account, char **sender, char **message, int *flags); | |
84 @endsignalproto | |
85 @signaldesc | |
86 Emitted when an IM is received. The callback can replace the name of the | |
87 sender, the message, or the flags by modifying the pointer to the | |
88 strings and integer. This can also be used to cancel a message by | |
89 returning @c TRUE. | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
90 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
91 Make sure to free @a *sender and @a *message before you replace them! |
6605 | 92 @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
|
93 @param account The account the message was received on. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
94 @param sender A pointer to the username of the sender. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
95 @param message A pointer to the message that was sent. |
6605 | 96 @endsignaldef |
97 | |
98 @signaldef displaying-chat-msg | |
99 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
100 gboolean (*displaying_chat_msg)(GaimAccount *account, char **message); |
6605 | 101 @endsignalproto |
102 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
103 Emitted just before a message is displayed in a chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
104 @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
|
105 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
|
106 a message by returning @c TRUE. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
107 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
108 Make sure to free @a *message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
109 @param account The account the message is being displayed on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
110 @param message A pointer to the message that will be displayed. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
111 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
6605 | 112 @endsignaldef |
113 | |
114 @signaldef displayed-chat-msg | |
115 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
116 void (*displayed_chat_msg)(GaimAccount *account, const char *message); |
6605 | 117 @endsignalproto |
118 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
119 Emitted after a message is displayed in a chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
120 @param account The account the message was displayed on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
121 @param message The message that was displayed. |
6605 | 122 @endsignaldef |
123 | |
124 @signaldef sending-chat-msg | |
125 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
126 void (*sending_chat_msg)(GaimAccount *account, char **message, int id); |
6605 | 127 @endsignalproto |
128 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
129 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
|
130 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
|
131 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
132 Make sure to free @a *message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
133 @param account The account the message is being sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
134 @param message A pointer to the message that will be sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
135 @param id The ID of the chat. |
6605 | 136 @endsignaldef |
137 | |
138 @signaldef sent-chat-msg | |
139 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
140 void (*sent_chat_msg)(GaimAccount *account, const char *message, int id); |
6605 | 141 @endsignalproto |
142 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
143 Emitted after sending a message to a chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
144 @param account The account the message was sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
145 @param message The message that was sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
146 @param id The ID of the chat. |
6605 | 147 @endsignaldef |
148 | |
149 @signaldef received-chat-msg | |
150 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
151 gboolean (*received_chat_msg)(GaimAccount *account, char **sender, char **message, int id); |
6605 | 152 @endsignalproto |
153 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
154 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
|
155 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
|
156 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
|
157 returning @c TRUE. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
158 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
159 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
|
160 @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
|
161 @param account The account the message was received on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
162 @param sender A pointer to the username of the sender. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
163 @param message A pointer to the message that was sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
164 @param id The ID of the chat. |
6605 | 165 @endsignaldef |
166 | |
167 @signaldef conversation-switching | |
168 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
169 void (*conversation_switching)(GaimConversation *old_conv, GaimConversation *new_conv); |
6605 | 170 @endsignalproto |
171 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
172 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
|
173 another. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
174 @param old_conv The old active conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
175 @param new_conv The soon-to-be active conversation |
6605 | 176 @endsignaldef |
177 | |
178 @signaldef conversation-switched | |
179 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
180 void (*conversation_switched)(GaimConversation *old_conv, GaimConversation *new_conv); |
6605 | 181 @endsignalproto |
182 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
183 Emitted when a window switched from one conversation to another. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
184 @param old_conv The old active conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
185 @param new_conv The now active conversation. |
6605 | 186 @endsignaldef |
187 | |
188 @signaldef conversation-created | |
189 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
190 void (*conversation_created)(GaimConversation *conv); |
6605 | 191 @endsignalproto |
192 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
193 Emitted when a new conversation is created. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
194 @param conv The new conversation. |
6605 | 195 @endsignaldef |
196 | |
197 @signaldef deleting-conversation | |
198 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
199 void (*deleting_conversation)(GaimConversation *conv); |
6605 | 200 @endsignalproto |
201 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
202 Emitted just before a conversation is to be destroyed. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
203 @param conv The conversation that's about to be destroyed. |
6605 | 204 @endsignaldef |
205 | |
206 @signaldef buddy-typing | |
207 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
208 void (*buddy_typing)(GaimConversation *conv); |
6605 | 209 @endsignalproto |
210 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
211 Emitted when a buddy starts typing in a conversation window. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
212 @param conv The IM conversation a buddy is typing in. |
6605 | 213 @endsignaldef |
214 | |
215 @signaldef chat-buddy-joining | |
216 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
217 void (*chat_buddy_joining)(GaimConversation *conv, const char *name); |
6605 | 218 @endsignalproto |
219 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
220 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
|
221 users in the chat updates to include the new user. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
222 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
223 @param name The name of the user that is joining the conversation. |
6605 | 224 @endsignaldef |
225 | |
226 @signaldef chat-buddy-joined | |
227 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
228 void (*chat_buddy_joined)(GaimConversation *conv, const char *name); |
6605 | 229 @endsignalproto |
230 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
231 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
|
232 @param conv The chat conversation. |
6605 | 233 @endsignaldef |
234 | |
235 @signaldef chat-buddy-leaving | |
236 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
237 void (*chat_buddy_leaving)(GaimConversation *conv, const char *name, const char *reason); |
6605 | 238 @endsignalproto |
239 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
240 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
|
241 This may include an optional reason why the user is leaving. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
242 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
243 @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
|
244 @param reason The optional reason why the user is leaving. |
6605 | 245 @endsignaldef |
246 | |
247 @signaldef chat-buddy-left | |
248 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
249 void (*chat_buddy_left)(GaimConversation *conv, const char *name, const char *reason); |
6605 | 250 @endsignalproto |
251 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
252 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
|
253 This may include an optional reason why the user is leaving. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
254 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
255 @param name The name of the user that left the chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
256 @param reason The optional reason why the user left the chat. |
6605 | 257 @endsignaldef |
258 | |
259 @signaldef chat-inviting-user | |
260 @signalproto | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
261 void (*chat_inviting_user)(GaimConversation *conv, const char *name, char **invite_message); |
6605 | 262 @endsignalproto |
263 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
264 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
|
265 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
|
266 the invite message. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
267 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
268 Make sure to free @a *invite_message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
269 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
270 @param name The name of the user being invited. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
271 @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
|
272 invited. |
6605 | 273 @endsignaldef |
274 | |
275 @signaldef chat-invited-user | |
276 @signalproto | |
277 void (*chat-invited-user)(GaimConversation *conv); | |
278 @endsignalproto | |
279 @param conv The conversation. | |
280 @signaldesc | |
281 | |
282 @endsignaldef | |
283 | |
284 @signaldef chat-invited | |
285 @signalproto | |
286 void (*chat-invited)(GaimConversation *conv); | |
287 @endsignalproto | |
288 @param conv The conversation. | |
289 @signaldesc | |
290 | |
291 @endsignaldef | |
292 | |
293 @signaldef chat-joined | |
294 @signalproto | |
295 void (*chat-joined)(GaimConversation *conv); | |
296 @endsignalproto | |
297 @param conv The conversation. | |
298 @signaldesc | |
299 | |
300 @endsignaldef | |
301 | |
302 @signaldef chat-left | |
303 @signalproto | |
304 void (*chat-left)(GaimConversation *conv); | |
305 @endsignalproto | |
306 @param conv The conversation. | |
307 @signaldesc | |
308 | |
309 @endsignaldef | |
310 | |
311 */ | |
312 // vim: syntax=c tw=75 et |