Mercurial > pidgin
annotate doc/conversation-signals.dox @ 17666:d81f57b8b3d1
Update for 0.8 - fix crash, password length.
author | Jeffrey Connelly <jaconnel@calpoly.edu> |
---|---|
date | Mon, 25 Jun 2007 05:51:13 +0000 |
parents | 36b09c6f7957 |
children | da2bab3b9fab |
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 sending-im-msg |
7 @signal sent-im-msg | |
8999 | 8 @signal receiving-im-msg |
6605 | 9 @signal received-im-msg |
8736 | 10 @signal writing-chat-msg |
11 @signal wrote-chat-msg | |
6605 | 12 @signal sending-chat-msg |
13 @signal sent-chat-msg | |
8999 | 14 @signal receiving-chat-msg |
6605 | 15 @signal received-chat-msg |
16 @signal conversation-created | |
12053 | 17 @signal conversation-updated |
6605 | 18 @signal deleting-conversation |
19 @signal buddy-typing | |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
20 @signal buddy-typing-stopped |
6605 | 21 @signal chat-buddy-joining |
22 @signal chat-buddy-joined | |
12053 | 23 @signal chat-buddy-flags |
6605 | 24 @signal chat-buddy-leaving |
25 @signal chat-buddy-left | |
26 @signal chat-inviting-user | |
27 @signal chat-invited-user | |
28 @signal chat-invited | |
29 @signal chat-joined | |
30 @signal chat-left | |
9517 | 31 @signal chat-topic-changed |
6605 | 32 @endsignals |
33 | |
8078 | 34 @signaldef writing-im-msg |
35 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
36 gboolean (*writing_im_msg)(PurpleAccount *account, const char *who, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
37 char **message, PurpleConversation *conv, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
38 PurpleMessageFlags flags); |
8078 | 39 @endsignalproto |
40 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
41 Emitted before a message is written in an IM conversation. If the |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
42 message is changed, then the changed message is displayed and logged |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
43 instead of the original message. |
8078 | 44 @note |
45 Make sure to free @a *message before you replace it! | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
46 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
47 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
48 @param message A pointer to the message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
49 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
50 @param flags Flags for this message. |
8078 | 51 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
52 @endsignaldef | |
53 | |
54 @signaldef wrote-im-msg | |
55 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
56 void (*wrote_im_msg)(PurpleAccount *account, const char *who, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
57 char *message, PurpleConversation *conv, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
58 PurpleMessageFlags flags); |
8078 | 59 @endsignalproto |
60 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
61 Emitted after a message is written and possibly displayed in a conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
62 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
63 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
64 @param message The message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
65 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
66 @param flags Flags for this message. |
6605 | 67 @endsignaldef |
68 | |
69 @signaldef sending-im-msg | |
70 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
71 void (*sending_im_msg)(PurpleAccount *account, const char *receiver, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
72 char **message); |
6605 | 73 @endsignalproto |
74 @signaldesc | |
75 Emitted before sending an IM to a user. @a message is a pointer to the | |
76 message string, so the plugin can replace the message before being sent. | |
77 @note | |
78 Make sure to free @a *message before you replace it! | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
79 @param account The account the message is being sent on. |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
80 @param receiver The username of the receiver. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
81 @param message A pointer to the outgoing message. This can be modified. |
6605 | 82 @endsignaldef |
83 | |
84 @signaldef sent-im-msg | |
85 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
86 void (*sent_im_msg)(PurpleAccount *account, const char *receiver, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
87 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 sending an IM to a user. |
6605 | 91 @param account The account the message was sent on. |
92 @param receiver The username of the receiver. | |
93 @param message The message that was sent. | |
94 @endsignaldef | |
95 | |
8999 | 96 @signaldef receiving-im-msg |
6605 | 97 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
98 gboolean (*receiving_im_msg)(PurpleAccount *account, char **sender, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
99 char **message, PurpleConversation *conv, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
100 PurpleMessageFlags *flags); |
6605 | 101 @endsignalproto |
102 @signaldesc | |
103 Emitted when an IM is received. The callback can replace the name of the | |
104 sender, the message, or the flags by modifying the pointer to the | |
105 strings and integer. This can also be used to cancel a message by | |
106 returning @c TRUE. | |
6608
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 *sender and @a *message before you replace them! |
6605 | 109 @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
|
110 @param account The account the message was received on. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
111 @param sender A pointer to the username of the sender. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
112 @param message A pointer to the message that was sent. |
10104 | 113 @param conv The IM conversation. |
114 @param flags A pointer to the IM message flags. | |
6605 | 115 @endsignaldef |
116 | |
8999 | 117 @signaldef received-im-msg |
118 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
119 void (*received_im_msg)(PurpleAccount *account, char *sender, char *message, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
120 PurpleConversation *conv, PurpleMessageFlags flags); |
8999 | 121 @endsignalproto |
122 @signaldesc | |
123 Emitted after an IM is received. | |
124 @param account The account the message was received on. | |
125 @param sender The username of the sender. | |
126 @param message The message that was sent. | |
10104 | 127 @param conv The IM conversation. |
128 @param flags The IM message flags. | |
8999 | 129 @endsignaldef |
130 | |
8078 | 131 @signaldef writing-chat-msg |
132 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
133 gboolean (*writing_chat_msg)(PurpleAccount *account, const char *who, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
134 char **message, PurpleConversation *conv, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
135 PurpleMessageFlags flags); |
8078 | 136 @endsignalproto |
137 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
138 Emitted before a message is written in a chat conversation. If the |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
139 message is changed, then the changed message is displayed and logged |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
140 instead of the original message. |
8078 | 141 @note |
142 Make sure to free @a *message before you replace it! | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
143 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
144 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
145 @param message A pointer to the message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
146 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
147 @param flags Flags for this message. |
8078 | 148 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
149 @endsignaldef | |
150 | |
8736 | 151 @signaldef wrote-chat-msg |
8078 | 152 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
153 void (*wrote_chat_msg)(PurpleAccount *account, const char *who, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
154 char *message, PurpleConversation *conv, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
155 PurpleMessageFlags flags); |
8078 | 156 @endsignalproto |
157 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
158 Emitted after a message is written and possibly displayed in a chat. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
159 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
160 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
161 @param message The message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
162 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
163 @param flags Flags for this message. |
6605 | 164 @endsignaldef |
165 | |
166 @signaldef sending-chat-msg | |
167 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
168 void (*sending_chat_msg)(PurpleAccount *account, char **message, int id); |
6605 | 169 @endsignalproto |
170 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
171 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
|
172 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
|
173 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
174 Make sure to free @a *message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
175 @param account The account the message is being sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
176 @param message A pointer to the message that will be sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
177 @param id The ID of the chat. |
6605 | 178 @endsignaldef |
179 | |
180 @signaldef sent-chat-msg | |
181 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
182 void (*sent_chat_msg)(PurpleAccount *account, const char *message, int id); |
6605 | 183 @endsignalproto |
184 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
185 Emitted after sending a message to a chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
186 @param account The account the message was sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
187 @param message The message that was sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
188 @param id The ID of the chat. |
6605 | 189 @endsignaldef |
190 | |
8999 | 191 @signaldef receiving-chat-msg |
6605 | 192 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
193 gboolean (*receiving_chat_msg)(PurpleAccount *account, char **sender, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
194 char **message, PurpleConversation *conv, int *flags); |
6605 | 195 @endsignalproto |
196 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
197 Emitted when a chat message is received. The callback can replace the |
10104 | 198 name of the sender, the message, or the flags by modifying the pointer to the |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
199 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
|
200 returning @c TRUE. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
201 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
202 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
|
203 @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
|
204 @param account The account the message was received on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
205 @param sender A pointer to the username of the sender. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
206 @param message A pointer to the message that was sent. |
7512
72a795d4b143
[gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents:
6838
diff
changeset
|
207 @param conv The chat conversation. |
10104 | 208 @param flags A pointer to the chat message flags |
6605 | 209 @endsignaldef |
210 | |
8999 | 211 @signaldef received-chat-msg |
212 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
213 void (*received_chat_msg)(PurpleAccount *account, char *sender, char *message, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
214 PurpleConversation *conv, PurpleMessageFlags flags); |
8999 | 215 @endsignalproto |
216 @signaldesc | |
217 Emitted after a chat message is received. | |
218 @param account The account the message was received on. | |
219 @param sender The username of the sender. | |
220 @param message The message that was sent. | |
221 @param conv The chat conversation. | |
10104 | 222 @param flags The chat message flags. |
8999 | 223 @endsignaldef |
224 | |
6605 | 225 @signaldef conversation-created |
226 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
227 void (*conversation_created)(PurpleConversation *conv); |
6605 | 228 @endsignalproto |
229 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
230 Emitted when a new conversation is created. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
231 @param conv The new conversation. |
6605 | 232 @endsignaldef |
233 | |
12053 | 234 @signaldef conversation-updated |
235 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
236 void (*conversation_updated)(PurpleConversation *conv, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
237 PurpleConvUpdateType type); |
12053 | 238 @endsignalproto |
239 @signaldesc | |
240 Emitted when a conversation is updated. | |
241 @param conv The conversation that was updated. | |
242 @param type The type of update that was made. | |
243 @endsignaldef | |
244 | |
6605 | 245 @signaldef deleting-conversation |
246 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
247 void (*deleting_conversation)(PurpleConversation *conv); |
6605 | 248 @endsignalproto |
249 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
250 Emitted just before a conversation is to be destroyed. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
251 @param conv The conversation that's about to be destroyed. |
6605 | 252 @endsignaldef |
253 | |
254 @signaldef buddy-typing | |
255 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
256 void (*buddy_typing)(PurpleAccount *account, const char *name); |
6605 | 257 @endsignalproto |
258 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
259 Emitted when a buddy starts typing in a conversation window. |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
260 @param account The account of the user which is typing. |
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
261 @param name The name of the user which is typing. |
6605 | 262 @endsignaldef |
263 | |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
264 @signaldef buddy-typing-stopped |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
265 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
266 void (*buddy_typing_stopped)(PurpleAccount *account, const char *name); |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
267 @endsignalproto |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
268 @signaldesc |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
269 Emitted when a buddy stops typing in a conversation window. |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
270 @param account The account of the user which stopped typing. |
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
271 @param name The name of the user which stopped typing. |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
272 @endsignaldef |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
273 |
6605 | 274 @signaldef chat-buddy-joining |
275 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
276 gboolean (*chat_buddy_joining)(PurpleConversation *conv, const char *name, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
277 PurpleConvChatBuddyFlags flags); |
6605 | 278 @endsignalproto |
279 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
280 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
|
281 users in the chat updates to include the new user. |
9587 | 282 @return @c TRUE if the join should be hidden, or @c FALSE otherwise. |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
283 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
284 @param name The name of the user that is joining the conversation. |
9554 | 285 @param flags The flags of the user that is joining the conversation. |
6605 | 286 @endsignaldef |
287 | |
288 @signaldef chat-buddy-joined | |
289 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
290 void (*chat_buddy_joined)(PurpleConversation *conv, const char *name, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
291 PurpleConvChatBuddyFlags flags, |
12850
49b2347863b2
[gaim-migrate @ 15200]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
292 gboolean new_arrival); |
6605 | 293 @endsignalproto |
294 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
295 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
|
296 @param conv The chat conversation. |
9554 | 297 @param name The name of the user that has joined the conversation. |
298 @param flags The flags of the user that has joined the conversation. | |
12850
49b2347863b2
[gaim-migrate @ 15200]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
299 @param new_arrival If the buddy is a new arrival. |
9554 | 300 @endsignaldef |
301 | |
302 @signaldef chat-buddy-flags | |
303 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
304 void (*chat_buddy_flags)(PurpleConversation *conv, const char *name, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
305 PurpleConvChatBuddyFlags oldflags, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
306 PurpleConvChatBuddyFlags newflags); |
9554 | 307 @endsignalproto |
308 @signaldesc | |
309 Emitted when a user in a chat changes flags. | |
310 @param conv The chat conversation. | |
311 @param name The name of the user. | |
312 @param oldflags The old flags. | |
313 @param newflags The new flags. | |
6605 | 314 @endsignaldef |
315 | |
316 @signaldef chat-buddy-leaving | |
317 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
318 gboolean (*chat_buddy_leaving)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
319 const char *reason); |
6605 | 320 @endsignalproto |
321 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
322 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
|
323 This may include an optional reason why the user is leaving. |
9587 | 324 @return @c TRUE if the leave should be hidden, or @c FALSE otherwise. |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
325 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
326 @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
|
327 @param reason The optional reason why the user is leaving. |
6605 | 328 @endsignaldef |
329 | |
330 @signaldef chat-buddy-left | |
331 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
332 void (*chat_buddy_left)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
333 const char *reason); |
6605 | 334 @endsignalproto |
335 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
336 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
|
337 This may include an optional reason why the user is leaving. |
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 left the chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
340 @param reason The optional reason why the user left the chat. |
6605 | 341 @endsignaldef |
342 | |
343 @signaldef chat-inviting-user | |
344 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
345 void (*chat_inviting_user)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
346 char **invite_message); |
6605 | 347 @endsignalproto |
348 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
349 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
|
350 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
|
351 the invite message. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
352 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
353 Make sure to free @a *invite_message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
354 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
355 @param name The name of the user being invited. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
356 @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
|
357 invited. |
6605 | 358 @endsignaldef |
359 | |
360 @signaldef chat-invited-user | |
361 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
362 void (*chat_invited_user)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
363 const char *invite_message); |
6605 | 364 @endsignalproto |
365 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
366 Emitted when a user invited another user to a chat. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
367 @param conv The chat conversation. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
368 @param conv The name of the user that was invited. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
369 @param invite_message The message to be sent to the user when invited. |
6605 | 370 @endsignaldef |
371 | |
372 @signaldef chat-invited | |
373 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
374 gint (*chat_invited)(PurpleAccount *account, const char *inviter, |
9514 | 375 const char *chat, const char *invite_message |
11474
7e9635b73ed6
[gaim-migrate @ 13715]
Gary Kramlich <grim@reaperworld.com>
parents:
11064
diff
changeset
|
376 const GHashTable *components); |
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. |
9484 | 382 @param chat The name of the chat you're being invited to. |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
383 @param invite_message The optional invite message. |
9514 | 384 @param components The components necessary if you want to call |
16201
36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
Richard Laager <rlaager@wiktel.com>
parents:
16183
diff
changeset
|
385 serv_join_chat() |
11064
e4459e8ccfb5
[gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents:
10104
diff
changeset
|
386 @return Less than zero if the invitation should be rejected, greater than |
e4459e8ccfb5
[gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents:
10104
diff
changeset
|
387 zero if the invitation should be accepted. If zero is returned, the |
e4459e8ccfb5
[gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents:
10104
diff
changeset
|
388 default behavior will be maintained: the user will be prompted. |
6605 | 389 @endsignaldef |
390 | |
391 @signaldef chat-joined | |
392 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
393 void (*chat_joined)(PurpleConversation *conv); |
6605 | 394 @endsignalproto |
395 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
396 Emitted when an account joins a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
397 @param conv The conversation that joined the chat room. |
6605 | 398 @endsignaldef |
399 | |
400 @signaldef chat-left | |
401 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
402 void (*chat_left)(PurpleConversation *conv); |
6605 | 403 @endsignalproto |
404 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
405 Emitted when an account leaves a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
406 @param conv The conversation that left the chat room. |
6605 | 407 @endsignaldef |
408 | |
9517 | 409 @signaldef chat-topic-changed |
410 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
411 void (*chat_topic_changed)(PurpleConversation *conv, const char *who, const char *topic); |
9517 | 412 @endsignalproto |
413 @signaldesc | |
414 Emitted when the topic is changed in a chat. | |
415 @param conv The conversation whose topic changed. | |
416 @param who The name of the person that changed the topic. | |
417 @param topic The new topic. | |
418 @endsignaldef | |
419 | |
6605 | 420 */ |
421 // vim: syntax=c tw=75 et |