Mercurial > pidgin
annotate doc/conversation-signals.dox @ 19206:919395a01483
- Implement x509_ca_get_cert
author | William Ehlhardt <williamehlhardt@gmail.com> |
---|---|
date | Mon, 13 Aug 2007 05:46:57 +0000 |
parents | da2bab3b9fab |
children | e0613cf8c493 |
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 |
17735
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
32 @signal conversation-extended-menu |
6605 | 33 @endsignals |
34 | |
8078 | 35 @signaldef writing-im-msg |
36 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
37 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
|
38 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
|
39 PurpleMessageFlags flags); |
8078 | 40 @endsignalproto |
41 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
42 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
|
43 message is changed, then the changed message is displayed and logged |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
44 instead of the original message. |
8078 | 45 @note |
46 Make sure to free @a *message before you replace it! | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
47 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
48 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
49 @param message A pointer to the message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
50 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
51 @param flags Flags for this message. |
8078 | 52 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
53 @endsignaldef | |
54 | |
55 @signaldef wrote-im-msg | |
56 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
57 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
|
58 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
|
59 PurpleMessageFlags flags); |
8078 | 60 @endsignalproto |
61 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
62 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
|
63 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
64 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
65 @param message The message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
66 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
67 @param flags Flags for this message. |
6605 | 68 @endsignaldef |
69 | |
70 @signaldef sending-im-msg | |
71 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
72 void (*sending_im_msg)(PurpleAccount *account, const char *receiver, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
73 char **message); |
6605 | 74 @endsignalproto |
75 @signaldesc | |
76 Emitted before sending an IM to a user. @a message is a pointer to the | |
77 message string, so the plugin can replace the message before being sent. | |
78 @note | |
79 Make sure to free @a *message before you replace it! | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
80 @param account The account the message is being sent on. |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
81 @param receiver The username of the receiver. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
82 @param message A pointer to the outgoing message. This can be modified. |
6605 | 83 @endsignaldef |
84 | |
85 @signaldef sent-im-msg | |
86 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
87 void (*sent_im_msg)(PurpleAccount *account, const char *receiver, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
88 const char *message); |
6605 | 89 @endsignalproto |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
90 @signaldesc |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
91 Emitted after sending an IM to a user. |
6605 | 92 @param account The account the message was sent on. |
93 @param receiver The username of the receiver. | |
94 @param message The message that was sent. | |
95 @endsignaldef | |
96 | |
8999 | 97 @signaldef receiving-im-msg |
6605 | 98 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
99 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
|
100 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
|
101 PurpleMessageFlags *flags); |
6605 | 102 @endsignalproto |
103 @signaldesc | |
104 Emitted when an IM is received. The callback can replace the name of the | |
105 sender, the message, or the flags by modifying the pointer to the | |
106 strings and integer. This can also be used to cancel a message by | |
107 returning @c TRUE. | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
108 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
109 Make sure to free @a *sender and @a *message before you replace them! |
6605 | 110 @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
|
111 @param account The account the message was received on. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
112 @param sender A pointer to the username of the sender. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
113 @param message A pointer to the message that was sent. |
10104 | 114 @param conv The IM conversation. |
115 @param flags A pointer to the IM message flags. | |
6605 | 116 @endsignaldef |
117 | |
8999 | 118 @signaldef received-im-msg |
119 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
120 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
|
121 PurpleConversation *conv, PurpleMessageFlags flags); |
8999 | 122 @endsignalproto |
123 @signaldesc | |
124 Emitted after an IM is received. | |
125 @param account The account the message was received on. | |
126 @param sender The username of the sender. | |
127 @param message The message that was sent. | |
10104 | 128 @param conv The IM conversation. |
129 @param flags The IM message flags. | |
8999 | 130 @endsignaldef |
131 | |
8078 | 132 @signaldef writing-chat-msg |
133 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
134 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
|
135 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
|
136 PurpleMessageFlags flags); |
8078 | 137 @endsignalproto |
138 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
139 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
|
140 message is changed, then the changed message is displayed and logged |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
141 instead of the original message. |
8078 | 142 @note |
143 Make sure to free @a *message before you replace it! | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
144 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
145 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
146 @param message A pointer to the message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
147 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
148 @param flags Flags for this message. |
8078 | 149 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
150 @endsignaldef | |
151 | |
8736 | 152 @signaldef wrote-chat-msg |
8078 | 153 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
154 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
|
155 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
|
156 PurpleMessageFlags flags); |
8078 | 157 @endsignalproto |
158 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
159 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
|
160 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
161 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
162 @param message The message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
163 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
164 @param flags Flags for this message. |
6605 | 165 @endsignaldef |
166 | |
167 @signaldef sending-chat-msg | |
168 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
169 void (*sending_chat_msg)(PurpleAccount *account, char **message, int id); |
6605 | 170 @endsignalproto |
171 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
172 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
|
173 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
|
174 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
175 Make sure to free @a *message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
176 @param account The account the message is being sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
177 @param message A pointer to the message that will be sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
178 @param id The ID of the chat. |
6605 | 179 @endsignaldef |
180 | |
181 @signaldef sent-chat-msg | |
182 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
183 void (*sent_chat_msg)(PurpleAccount *account, const char *message, int id); |
6605 | 184 @endsignalproto |
185 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
186 Emitted after sending a message to a chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
187 @param account The account the message was sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
188 @param message The message that was sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
189 @param id The ID of the chat. |
6605 | 190 @endsignaldef |
191 | |
8999 | 192 @signaldef receiving-chat-msg |
6605 | 193 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
194 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
|
195 char **message, PurpleConversation *conv, int *flags); |
6605 | 196 @endsignalproto |
197 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
198 Emitted when a chat message is received. The callback can replace the |
10104 | 199 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
|
200 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
|
201 returning @c TRUE. |
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 *sender and @a *message before you replace them! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
204 @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
|
205 @param account The account the message was received on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
206 @param sender A pointer to the username of the sender. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
207 @param message A pointer to the message that was sent. |
7512
72a795d4b143
[gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents:
6838
diff
changeset
|
208 @param conv The chat conversation. |
10104 | 209 @param flags A pointer to the chat message flags |
6605 | 210 @endsignaldef |
211 | |
8999 | 212 @signaldef received-chat-msg |
213 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
214 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
|
215 PurpleConversation *conv, PurpleMessageFlags flags); |
8999 | 216 @endsignalproto |
217 @signaldesc | |
218 Emitted after a chat message is received. | |
219 @param account The account the message was received on. | |
220 @param sender The username of the sender. | |
221 @param message The message that was sent. | |
222 @param conv The chat conversation. | |
10104 | 223 @param flags The chat message flags. |
8999 | 224 @endsignaldef |
225 | |
6605 | 226 @signaldef conversation-created |
227 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
228 void (*conversation_created)(PurpleConversation *conv); |
6605 | 229 @endsignalproto |
230 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
231 Emitted when a new conversation is created. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
232 @param conv The new conversation. |
6605 | 233 @endsignaldef |
234 | |
12053 | 235 @signaldef conversation-updated |
236 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
237 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
|
238 PurpleConvUpdateType type); |
12053 | 239 @endsignalproto |
240 @signaldesc | |
241 Emitted when a conversation is updated. | |
242 @param conv The conversation that was updated. | |
243 @param type The type of update that was made. | |
244 @endsignaldef | |
245 | |
6605 | 246 @signaldef deleting-conversation |
247 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
248 void (*deleting_conversation)(PurpleConversation *conv); |
6605 | 249 @endsignalproto |
250 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
251 Emitted just before a conversation is to be destroyed. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
252 @param conv The conversation that's about to be destroyed. |
6605 | 253 @endsignaldef |
254 | |
255 @signaldef buddy-typing | |
256 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
257 void (*buddy_typing)(PurpleAccount *account, const char *name); |
6605 | 258 @endsignalproto |
259 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
260 Emitted when a buddy starts typing in a conversation window. |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
261 @param account The account of the user which is typing. |
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
262 @param name The name of the user which is typing. |
6605 | 263 @endsignaldef |
264 | |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
265 @signaldef buddy-typing-stopped |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
266 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
267 void (*buddy_typing_stopped)(PurpleAccount *account, const char *name); |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
268 @endsignalproto |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
269 @signaldesc |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
270 Emitted when a buddy stops typing in a conversation window. |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
271 @param account The account of the user which stopped typing. |
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
272 @param name The name of the user which stopped typing. |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
273 @endsignaldef |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
274 |
6605 | 275 @signaldef chat-buddy-joining |
276 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
277 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
|
278 PurpleConvChatBuddyFlags flags); |
6605 | 279 @endsignalproto |
280 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
281 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
|
282 users in the chat updates to include the new user. |
9587 | 283 @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
|
284 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
285 @param name The name of the user that is joining the conversation. |
9554 | 286 @param flags The flags of the user that is joining the conversation. |
6605 | 287 @endsignaldef |
288 | |
289 @signaldef chat-buddy-joined | |
290 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
291 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
|
292 PurpleConvChatBuddyFlags flags, |
12850
49b2347863b2
[gaim-migrate @ 15200]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
293 gboolean new_arrival); |
6605 | 294 @endsignalproto |
295 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
296 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
|
297 @param conv The chat conversation. |
9554 | 298 @param name The name of the user that has joined the conversation. |
299 @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
|
300 @param new_arrival If the buddy is a new arrival. |
9554 | 301 @endsignaldef |
302 | |
303 @signaldef chat-buddy-flags | |
304 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
305 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
|
306 PurpleConvChatBuddyFlags oldflags, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
307 PurpleConvChatBuddyFlags newflags); |
9554 | 308 @endsignalproto |
309 @signaldesc | |
310 Emitted when a user in a chat changes flags. | |
311 @param conv The chat conversation. | |
312 @param name The name of the user. | |
313 @param oldflags The old flags. | |
314 @param newflags The new flags. | |
6605 | 315 @endsignaldef |
316 | |
317 @signaldef chat-buddy-leaving | |
318 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
319 gboolean (*chat_buddy_leaving)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
320 const char *reason); |
6605 | 321 @endsignalproto |
322 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
323 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
|
324 This may include an optional reason why the user is leaving. |
9587 | 325 @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
|
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 | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
333 void (*chat_buddy_left)(PurpleConversation *conv, const char *name, |
6609
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 | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
346 void (*chat_inviting_user)(PurpleConversation *conv, const char *name, |
6609
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 | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
363 void (*chat_invited_user)(PurpleConversation *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 | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
375 gint (*chat_invited)(PurpleAccount *account, const char *inviter, |
9514 | 376 const char *chat, const char *invite_message |
11474
7e9635b73ed6
[gaim-migrate @ 13715]
Gary Kramlich <grim@reaperworld.com>
parents:
11064
diff
changeset
|
377 const GHashTable *components); |
6605 | 378 @endsignalproto |
379 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
380 Emitted when an account was invited to a chat. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
381 @param account The account being invited. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
382 @param inviter The username of the person inviting the account. |
9484 | 383 @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
|
384 @param invite_message The optional invite message. |
9514 | 385 @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
|
386 serv_join_chat() |
11064
e4459e8ccfb5
[gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents:
10104
diff
changeset
|
387 @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
|
388 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
|
389 default behavior will be maintained: the user will be prompted. |
6605 | 390 @endsignaldef |
391 | |
392 @signaldef chat-joined | |
393 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
394 void (*chat_joined)(PurpleConversation *conv); |
6605 | 395 @endsignalproto |
396 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
397 Emitted when an account joins a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
398 @param conv The conversation that joined the chat room. |
6605 | 399 @endsignaldef |
400 | |
401 @signaldef chat-left | |
402 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
403 void (*chat_left)(PurpleConversation *conv); |
6605 | 404 @endsignalproto |
405 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
406 Emitted when an account leaves a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
407 @param conv The conversation that left the chat room. |
6605 | 408 @endsignaldef |
409 | |
9517 | 410 @signaldef chat-topic-changed |
411 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
412 void (*chat_topic_changed)(PurpleConversation *conv, const char *who, const char *topic); |
9517 | 413 @endsignalproto |
414 @signaldesc | |
415 Emitted when the topic is changed in a chat. | |
416 @param conv The conversation whose topic changed. | |
417 @param who The name of the person that changed the topic. | |
418 @param topic The new topic. | |
419 @endsignaldef | |
420 | |
17735
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
421 @signaldef conversation-extended-menu |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
422 @signalproto |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
423 void (*conversation_extended_menu)(PurpleConversation *conv, GList **list); |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
424 @endsignalproto |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
425 @signaldesc |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
426 Emitted when the UI requests a list of plugin actions for a |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
427 conversation. |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
428 @param conv The conversation. |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
429 @param list A pointer to the list of actions. |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
430 @endsignaldef |
6605 | 431 */ |
432 // vim: syntax=c tw=75 et |