Mercurial > pidgin.yaz
annotate doc/conversation-signals.dox @ 23831:b87bed1e6d1c
.
author | Ka-Hing Cheung <khc@hxbc.us> |
---|---|
date | Sat, 16 Aug 2008 04:31:11 +0000 |
parents | ff8ec3d58367 |
children | 29502959f74a |
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 |
23171
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
10 @signal blocked-im-msg |
8736 | 11 @signal writing-chat-msg |
12 @signal wrote-chat-msg | |
6605 | 13 @signal sending-chat-msg |
14 @signal sent-chat-msg | |
8999 | 15 @signal receiving-chat-msg |
6605 | 16 @signal received-chat-msg |
17 @signal conversation-created | |
12053 | 18 @signal conversation-updated |
6605 | 19 @signal deleting-conversation |
20 @signal buddy-typing | |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
21 @signal buddy-typing-stopped |
6605 | 22 @signal chat-buddy-joining |
23 @signal chat-buddy-joined | |
12053 | 24 @signal chat-buddy-flags |
6605 | 25 @signal chat-buddy-leaving |
26 @signal chat-buddy-left | |
27 @signal chat-inviting-user | |
28 @signal chat-invited-user | |
29 @signal chat-invited | |
23171
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
30 @signal chat-invite-blocked |
6605 | 31 @signal chat-joined |
23105
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
32 @signal chat-join-failed |
6605 | 33 @signal chat-left |
9517 | 34 @signal chat-topic-changed |
17220
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
35 @signal conversation-extended-menu |
6605 | 36 @endsignals |
37 | |
20807
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
17220
diff
changeset
|
38 @see conversation.h |
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
17220
diff
changeset
|
39 |
8078 | 40 @signaldef writing-im-msg |
41 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
42 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
|
43 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
|
44 PurpleMessageFlags flags); |
8078 | 45 @endsignalproto |
46 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
47 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
|
48 message is changed, then the changed message is displayed and logged |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
49 instead of the original message. |
8078 | 50 @note |
51 Make sure to free @a *message before you replace it! | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
52 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
53 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
54 @param message A pointer to the message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
55 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
56 @param flags Flags for this message. |
8078 | 57 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
58 @endsignaldef | |
59 | |
60 @signaldef wrote-im-msg | |
61 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
62 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
|
63 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
|
64 PurpleMessageFlags flags); |
8078 | 65 @endsignalproto |
66 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
67 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
|
68 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
69 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
70 @param message The message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
71 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
72 @param flags Flags for this message. |
6605 | 73 @endsignaldef |
74 | |
75 @signaldef sending-im-msg | |
76 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
77 void (*sending_im_msg)(PurpleAccount *account, const char *receiver, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
78 char **message); |
6605 | 79 @endsignalproto |
80 @signaldesc | |
81 Emitted before sending an IM to a user. @a message is a pointer to the | |
82 message string, so the plugin can replace the message before being sent. | |
83 @note | |
84 Make sure to free @a *message before you replace it! | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
85 @param account The account the message is being sent on. |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
86 @param receiver The username of the receiver. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
87 @param message A pointer to the outgoing message. This can be modified. |
6605 | 88 @endsignaldef |
89 | |
90 @signaldef sent-im-msg | |
91 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
92 void (*sent_im_msg)(PurpleAccount *account, const char *receiver, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
93 const char *message); |
6605 | 94 @endsignalproto |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
95 @signaldesc |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
96 Emitted after sending an IM to a user. |
6605 | 97 @param account The account the message was sent on. |
98 @param receiver The username of the receiver. | |
99 @param message The message that was sent. | |
100 @endsignaldef | |
101 | |
8999 | 102 @signaldef receiving-im-msg |
6605 | 103 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
104 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
|
105 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
|
106 PurpleMessageFlags *flags); |
6605 | 107 @endsignalproto |
108 @signaldesc | |
109 Emitted when an IM is received. The callback can replace the name of the | |
110 sender, the message, or the flags by modifying the pointer to the | |
111 strings and integer. This can also be used to cancel a message by | |
112 returning @c TRUE. | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
113 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
114 Make sure to free @a *sender and @a *message before you replace them! |
6605 | 115 @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
|
116 @param account The account the message was received on. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
117 @param sender A pointer to the username of the sender. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
118 @param message A pointer to the message that was sent. |
10104 | 119 @param conv The IM conversation. |
120 @param flags A pointer to the IM message flags. | |
6605 | 121 @endsignaldef |
122 | |
8999 | 123 @signaldef received-im-msg |
124 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
125 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
|
126 PurpleConversation *conv, PurpleMessageFlags flags); |
8999 | 127 @endsignalproto |
128 @signaldesc | |
129 Emitted after an IM is received. | |
130 @param account The account the message was received on. | |
131 @param sender The username of the sender. | |
132 @param message The message that was sent. | |
10104 | 133 @param conv The IM conversation. |
134 @param flags The IM message flags. | |
8999 | 135 @endsignaldef |
136 | |
23171
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
137 @signaldef blocked-im-msg |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
138 @signalproto |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
139 void (*blocked_im_msg)(PurpleAccount *account, const char *sender, |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
140 const char *message, PurpleMessageFlags flags, time_t when); |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
141 @endsignalproto |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
142 @signaldesc |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
143 Emitted after an IM is blocked due to privacy settings. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
144 @param account The account the message was received on. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
145 @param sender The username of the sender. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
146 @param message The message that was blocked. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
147 @param flags The IM message flags. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
148 @param when The time the message was sent. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
149 @since 2.5.0 |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
150 @endsignaldef |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
151 |
8078 | 152 @signaldef writing-chat-msg |
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 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
|
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 before a message is written in a chat conversation. If the |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
160 message is changed, then the changed message is displayed and logged |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
161 instead of the original message. |
8078 | 162 @note |
163 Make sure to free @a *message before you replace it! | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
164 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
165 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
166 @param message A pointer to the message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
167 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
168 @param flags Flags for this message. |
8078 | 169 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
170 @endsignaldef | |
171 | |
8736 | 172 @signaldef wrote-chat-msg |
8078 | 173 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
174 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
|
175 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
|
176 PurpleMessageFlags flags); |
8078 | 177 @endsignalproto |
178 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
179 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
|
180 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
181 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
182 @param message The message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
183 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
184 @param flags Flags for this message. |
6605 | 185 @endsignaldef |
186 | |
187 @signaldef sending-chat-msg | |
188 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
189 void (*sending_chat_msg)(PurpleAccount *account, char **message, int id); |
6605 | 190 @endsignalproto |
191 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
192 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
|
193 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
|
194 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
195 Make sure to free @a *message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
196 @param account The account the message is being sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
197 @param message A pointer to the message that will be sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
198 @param id The ID of the chat. |
6605 | 199 @endsignaldef |
200 | |
201 @signaldef sent-chat-msg | |
202 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
203 void (*sent_chat_msg)(PurpleAccount *account, const char *message, int id); |
6605 | 204 @endsignalproto |
205 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
206 Emitted after sending a message to a chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
207 @param account The account the message was sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
208 @param message The message that was sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
209 @param id The ID of the chat. |
6605 | 210 @endsignaldef |
211 | |
8999 | 212 @signaldef receiving-chat-msg |
6605 | 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 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
|
215 char **message, PurpleConversation *conv, int *flags); |
6605 | 216 @endsignalproto |
217 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
218 Emitted when a chat message is received. The callback can replace the |
10104 | 219 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
|
220 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
|
221 returning @c TRUE. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
222 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
223 Make sure to free @a *sender and @a *message before you replace them! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
224 @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
|
225 @param account The account the message was received on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
226 @param sender A pointer to the username of the sender. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
227 @param message A pointer to the message that was sent. |
7512
72a795d4b143
[gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents:
6838
diff
changeset
|
228 @param conv The chat conversation. |
10104 | 229 @param flags A pointer to the chat message flags |
6605 | 230 @endsignaldef |
231 | |
8999 | 232 @signaldef received-chat-msg |
233 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
234 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
|
235 PurpleConversation *conv, PurpleMessageFlags flags); |
8999 | 236 @endsignalproto |
237 @signaldesc | |
238 Emitted after a chat message is received. | |
239 @param account The account the message was received on. | |
240 @param sender The username of the sender. | |
241 @param message The message that was sent. | |
242 @param conv The chat conversation. | |
10104 | 243 @param flags The chat message flags. |
8999 | 244 @endsignaldef |
245 | |
6605 | 246 @signaldef conversation-created |
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 (*conversation_created)(PurpleConversation *conv); |
6605 | 249 @endsignalproto |
250 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
251 Emitted when a new conversation is created. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
252 @param conv The new conversation. |
6605 | 253 @endsignaldef |
254 | |
12053 | 255 @signaldef conversation-updated |
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 (*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
|
258 PurpleConvUpdateType type); |
12053 | 259 @endsignalproto |
260 @signaldesc | |
261 Emitted when a conversation is updated. | |
262 @param conv The conversation that was updated. | |
263 @param type The type of update that was made. | |
264 @endsignaldef | |
265 | |
6605 | 266 @signaldef deleting-conversation |
267 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
268 void (*deleting_conversation)(PurpleConversation *conv); |
6605 | 269 @endsignalproto |
270 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
271 Emitted just before a conversation is to be destroyed. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
272 @param conv The conversation that's about to be destroyed. |
6605 | 273 @endsignaldef |
274 | |
275 @signaldef buddy-typing | |
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 void (*buddy_typing)(PurpleAccount *account, const char *name); |
6605 | 278 @endsignalproto |
279 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
280 Emitted when a buddy starts typing in a conversation window. |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
281 @param account The account of the user which is typing. |
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
282 @param name The name of the user which is typing. |
6605 | 283 @endsignaldef |
284 | |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
285 @signaldef buddy-typing-stopped |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
286 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
287 void (*buddy_typing_stopped)(PurpleAccount *account, const char *name); |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
288 @endsignalproto |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
289 @signaldesc |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
290 Emitted when a buddy stops typing in a conversation window. |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
291 @param account The account of the user which stopped typing. |
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
292 @param name The name of the user which stopped typing. |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
293 @endsignaldef |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
294 |
6605 | 295 @signaldef chat-buddy-joining |
296 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
297 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
|
298 PurpleConvChatBuddyFlags flags); |
6605 | 299 @endsignalproto |
300 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
301 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
|
302 users in the chat updates to include the new user. |
9587 | 303 @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
|
304 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
305 @param name The name of the user that is joining the conversation. |
9554 | 306 @param flags The flags of the user that is joining the conversation. |
6605 | 307 @endsignaldef |
308 | |
309 @signaldef chat-buddy-joined | |
310 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
311 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
|
312 PurpleConvChatBuddyFlags flags, |
12850
49b2347863b2
[gaim-migrate @ 15200]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
313 gboolean new_arrival); |
6605 | 314 @endsignalproto |
315 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
316 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
|
317 @param conv The chat conversation. |
9554 | 318 @param name The name of the user that has joined the conversation. |
319 @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
|
320 @param new_arrival If the buddy is a new arrival. |
9554 | 321 @endsignaldef |
322 | |
23105
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
323 @signaldef chat-join-failed |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
324 @signalproto |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
325 void (*chat_join_failed)(PurpleConnection *gc, GHashTable *components); |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
326 @endsignalproto |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
327 @signaldesc |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
328 Emitted when an account fails to join a chat room |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
329 @param gc The PurpleConnection of the account which failed to join the chat. |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
330 @param data The components passed to serv_join_chat() originally. |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
331 The hash function should be g_str_hash() and the equal |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
332 function should be g_str_equal(). |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
333 @endsignaldef |
591ef3693345
As discussed on the devel list, purple_serv_got_join_chat_failed() and the
Evan Schoenberg <evan.s@dreskin.net>
parents:
22742
diff
changeset
|
334 |
9554 | 335 @signaldef chat-buddy-flags |
336 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
337 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
|
338 PurpleConvChatBuddyFlags oldflags, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
339 PurpleConvChatBuddyFlags newflags); |
9554 | 340 @endsignalproto |
341 @signaldesc | |
342 Emitted when a user in a chat changes flags. | |
343 @param conv The chat conversation. | |
344 @param name The name of the user. | |
345 @param oldflags The old flags. | |
346 @param newflags The new flags. | |
6605 | 347 @endsignaldef |
348 | |
349 @signaldef chat-buddy-leaving | |
350 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
351 gboolean (*chat_buddy_leaving)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
352 const char *reason); |
6605 | 353 @endsignalproto |
354 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
355 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
|
356 This may include an optional reason why the user is leaving. |
9587 | 357 @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
|
358 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
359 @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
|
360 @param reason The optional reason why the user is leaving. |
6605 | 361 @endsignaldef |
362 | |
363 @signaldef chat-buddy-left | |
364 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
365 void (*chat_buddy_left)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
366 const char *reason); |
6605 | 367 @endsignalproto |
368 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
369 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
|
370 This may include an optional reason why the user is leaving. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
371 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
372 @param name The name of the user that left the chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
373 @param reason The optional reason why the user left the chat. |
6605 | 374 @endsignaldef |
375 | |
376 @signaldef chat-inviting-user | |
377 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
378 void (*chat_inviting_user)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
379 char **invite_message); |
6605 | 380 @endsignalproto |
381 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
382 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
|
383 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
|
384 the invite message. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
385 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
386 Make sure to free @a *invite_message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
387 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
388 @param name The name of the user being invited. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
389 @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
|
390 invited. |
6605 | 391 @endsignaldef |
392 | |
393 @signaldef chat-invited-user | |
394 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
395 void (*chat_invited_user)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
396 const char *invite_message); |
6605 | 397 @endsignalproto |
398 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
399 Emitted when a user invited another user to a chat. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
400 @param conv The chat conversation. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
401 @param conv The name of the user that was invited. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
402 @param invite_message The message to be sent to the user when invited. |
6605 | 403 @endsignaldef |
404 | |
405 @signaldef chat-invited | |
406 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
407 gint (*chat_invited)(PurpleAccount *account, const char *inviter, |
9514 | 408 const char *chat, const char *invite_message |
11474
7e9635b73ed6
[gaim-migrate @ 13715]
Gary Kramlich <grim@reaperworld.com>
parents:
11064
diff
changeset
|
409 const GHashTable *components); |
6605 | 410 @endsignalproto |
411 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
412 Emitted when an account was invited to a chat. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
413 @param account The account being invited. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
414 @param inviter The username of the person inviting the account. |
9484 | 415 @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
|
416 @param invite_message The optional invite message. |
9514 | 417 @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
|
418 serv_join_chat() |
11064
e4459e8ccfb5
[gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents:
10104
diff
changeset
|
419 @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
|
420 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
|
421 default behavior will be maintained: the user will be prompted. |
6605 | 422 @endsignaldef |
423 | |
23171
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
424 @signaldef chat-invite-blocked |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
425 @signalproto |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
426 void (*chat_invite_blocked)(PurpleAccount *account, const char *inviter, |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
427 const char *name, const char *message, GHashTable *data); |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
428 @endsignalproto |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
429 @signaldesc |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
430 Emitted when an invitation to join a chat is blocked. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
431 @param account The account the invitation was sent to. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
432 @param inviter The name of the person sending the invitation. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
433 @param name The name of the chat invited to. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
434 @param message The invitation message sent. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
435 @param data Hashtable containing data about the invited chat. |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
436 @since 2.5.0 |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
437 @endsignaldef |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
438 |
6605 | 439 @signaldef chat-joined |
440 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
441 void (*chat_joined)(PurpleConversation *conv); |
6605 | 442 @endsignalproto |
443 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
444 Emitted when an account joins a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
445 @param conv The conversation that joined the chat room. |
6605 | 446 @endsignaldef |
447 | |
448 @signaldef chat-left | |
449 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
450 void (*chat_left)(PurpleConversation *conv); |
6605 | 451 @endsignalproto |
452 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
453 Emitted when an account leaves a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
454 @param conv The conversation that left the chat room. |
6605 | 455 @endsignaldef |
456 | |
9517 | 457 @signaldef chat-topic-changed |
458 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
459 void (*chat_topic_changed)(PurpleConversation *conv, const char *who, const char *topic); |
9517 | 460 @endsignalproto |
461 @signaldesc | |
462 Emitted when the topic is changed in a chat. | |
463 @param conv The conversation whose topic changed. | |
464 @param who The name of the person that changed the topic. | |
465 @param topic The new topic. | |
466 @endsignaldef | |
467 | |
17220
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
468 @signaldef conversation-extended-menu |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
469 @signalproto |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
470 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
|
471 @endsignalproto |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
472 @signaldesc |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
473 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
|
474 conversation. |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
475 @param conv The conversation. |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
476 @param list A pointer to the list of actions. |
20875
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20807
diff
changeset
|
477 @since 2.1.0 |
17220
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
478 @endsignaldef |
6605 | 479 */ |
20807
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
17220
diff
changeset
|
480 // vim: syntax=c.doxygen tw=75 et |