Mercurial > pidgin.yaz
annotate doc/conversation-signals.dox @ 32119:df7a22ec0bc3
No more warnings when receiving Gadu-Gadu system messages - fixes #13914
author | tomkiewicz@cpw.pidgin.im |
---|---|
date | Mon, 13 Jun 2011 19:22:24 +0000 |
parents | a9e077fb65e9 |
children | 02a2e8183b1d |
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 |
31894
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
35 @signal cleared-message-history |
17220
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
36 @signal conversation-extended-menu |
30178
29502959f74a
Add the attention-UI-related signals to the documentation
Marcus Lundblad <ml@update.uu.se>
parents:
23171
diff
changeset
|
37 @signal sent-attention |
29502959f74a
Add the attention-UI-related signals to the documentation
Marcus Lundblad <ml@update.uu.se>
parents:
23171
diff
changeset
|
38 @signal got-attention |
6605 | 39 @endsignals |
40 | |
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
|
41 @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
|
42 |
8078 | 43 @signaldef writing-im-msg |
44 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
45 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
|
46 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
|
47 PurpleMessageFlags flags); |
8078 | 48 @endsignalproto |
49 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
50 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
|
51 message is changed, then the changed message is displayed and logged |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
52 instead of the original message. |
8078 | 53 @note |
54 Make sure to free @a *message before you replace it! | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
55 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
56 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
57 @param message A pointer to the message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
58 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
59 @param flags Flags for this message. |
8078 | 60 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
61 @endsignaldef | |
62 | |
63 @signaldef wrote-im-msg | |
64 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
65 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
|
66 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
|
67 PurpleMessageFlags flags); |
8078 | 68 @endsignalproto |
69 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
70 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
|
71 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
72 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
73 @param message The message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
74 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
75 @param flags Flags for this message. |
6605 | 76 @endsignaldef |
77 | |
78 @signaldef sending-im-msg | |
79 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
80 void (*sending_im_msg)(PurpleAccount *account, const char *receiver, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
81 char **message); |
6605 | 82 @endsignalproto |
83 @signaldesc | |
84 Emitted before sending an IM to a user. @a message is a pointer to the | |
85 message string, so the plugin can replace the message before being sent. | |
86 @note | |
87 Make sure to free @a *message before you replace it! | |
8276
3c49a619969f
[gaim-migrate @ 9000]
Christian Hammond <chipx86@chipx86.com>
parents:
8078
diff
changeset
|
88 @param account The account the message is being sent on. |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
89 @param receiver The username of the receiver. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
90 @param message A pointer to the outgoing message. This can be modified. |
6605 | 91 @endsignaldef |
92 | |
93 @signaldef sent-im-msg | |
94 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
95 void (*sent_im_msg)(PurpleAccount *account, const char *receiver, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
96 const char *message); |
6605 | 97 @endsignalproto |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
98 @signaldesc |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
99 Emitted after sending an IM to a user. |
6605 | 100 @param account The account the message was sent on. |
101 @param receiver The username of the receiver. | |
102 @param message The message that was sent. | |
103 @endsignaldef | |
104 | |
8999 | 105 @signaldef receiving-im-msg |
6605 | 106 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
107 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
|
108 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
|
109 PurpleMessageFlags *flags); |
6605 | 110 @endsignalproto |
111 @signaldesc | |
112 Emitted when an IM is received. The callback can replace the name of the | |
113 sender, the message, or the flags by modifying the pointer to the | |
114 strings and integer. This can also be used to cancel a message by | |
115 returning @c TRUE. | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
116 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
117 Make sure to free @a *sender and @a *message before you replace them! |
6605 | 118 @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
|
119 @param account The account the message was received on. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
120 @param sender A pointer to the username of the sender. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
121 @param message A pointer to the message that was sent. |
10104 | 122 @param conv The IM conversation. |
123 @param flags A pointer to the IM message flags. | |
6605 | 124 @endsignaldef |
125 | |
8999 | 126 @signaldef received-im-msg |
127 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
128 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
|
129 PurpleConversation *conv, PurpleMessageFlags flags); |
8999 | 130 @endsignalproto |
131 @signaldesc | |
132 Emitted after an IM is received. | |
133 @param account The account the message was received on. | |
134 @param sender The username of the sender. | |
135 @param message The message that was sent. | |
10104 | 136 @param conv The IM conversation. |
137 @param flags The IM message flags. | |
8999 | 138 @endsignaldef |
139 | |
23171
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
140 @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
|
141 @signalproto |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
142 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
|
143 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
|
144 @endsignalproto |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
145 @signaldesc |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
146 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
|
147 @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
|
148 @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
|
149 @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
|
150 @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
|
151 @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
|
152 @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
|
153 @endsignaldef |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
154 |
8078 | 155 @signaldef writing-chat-msg |
156 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
157 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
|
158 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
|
159 PurpleMessageFlags flags); |
8078 | 160 @endsignalproto |
161 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
162 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
|
163 message is changed, then the changed message is displayed and logged |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
164 instead of the original message. |
8078 | 165 @note |
166 Make sure to free @a *message before you replace it! | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
167 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
168 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
169 @param message A pointer to the message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
170 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
171 @param flags Flags for this message. |
8078 | 172 @return @c TRUE if the message should be canceled, or @c FALSE otherwise. |
173 @endsignaldef | |
174 | |
8736 | 175 @signaldef wrote-chat-msg |
8078 | 176 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
177 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
|
178 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
|
179 PurpleMessageFlags flags); |
8078 | 180 @endsignalproto |
181 @signaldesc | |
13233
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
182 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
|
183 @param account The account. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
184 @param who The name of the user. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
185 @param message The message. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
186 @param conv The conversation. |
f09c6e8df82c
[gaim-migrate @ 15598]
Richard Laager <rlaager@wiktel.com>
parents:
12850
diff
changeset
|
187 @param flags Flags for this message. |
6605 | 188 @endsignaldef |
189 | |
190 @signaldef sending-chat-msg | |
191 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
192 void (*sending_chat_msg)(PurpleAccount *account, char **message, int id); |
6605 | 193 @endsignalproto |
194 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
195 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
|
196 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
|
197 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
198 Make sure to free @a *message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
199 @param account The account the message is being sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
200 @param message A pointer to the message that will be sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
201 @param id The ID of the chat. |
6605 | 202 @endsignaldef |
203 | |
204 @signaldef sent-chat-msg | |
205 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
206 void (*sent_chat_msg)(PurpleAccount *account, const char *message, int id); |
6605 | 207 @endsignalproto |
208 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
209 Emitted after sending a message to a chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
210 @param account The account the message was sent on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
211 @param message The message that was sent. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
212 @param id The ID of the chat. |
6605 | 213 @endsignaldef |
214 | |
8999 | 215 @signaldef receiving-chat-msg |
6605 | 216 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
217 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
|
218 char **message, PurpleConversation *conv, int *flags); |
6605 | 219 @endsignalproto |
220 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
221 Emitted when a chat message is received. The callback can replace the |
10104 | 222 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
|
223 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
|
224 returning @c TRUE. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
225 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
226 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
|
227 @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
|
228 @param account The account the message was received on. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
229 @param sender A pointer to the username of the sender. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
230 @param message A pointer to the message that was sent. |
7512
72a795d4b143
[gaim-migrate @ 8125]
Christian Hammond <chipx86@chipx86.com>
parents:
6838
diff
changeset
|
231 @param conv The chat conversation. |
10104 | 232 @param flags A pointer to the chat message flags |
6605 | 233 @endsignaldef |
234 | |
8999 | 235 @signaldef received-chat-msg |
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 (*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
|
238 PurpleConversation *conv, PurpleMessageFlags flags); |
8999 | 239 @endsignalproto |
240 @signaldesc | |
241 Emitted after a chat message is received. | |
242 @param account The account the message was received on. | |
243 @param sender The username of the sender. | |
244 @param message The message that was sent. | |
245 @param conv The chat conversation. | |
10104 | 246 @param flags The chat message flags. |
8999 | 247 @endsignaldef |
248 | |
6605 | 249 @signaldef conversation-created |
250 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
251 void (*conversation_created)(PurpleConversation *conv); |
6605 | 252 @endsignalproto |
253 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
254 Emitted when a new conversation is created. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
255 @param conv The new conversation. |
6605 | 256 @endsignaldef |
257 | |
12053 | 258 @signaldef conversation-updated |
259 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
260 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
|
261 PurpleConvUpdateType type); |
12053 | 262 @endsignalproto |
263 @signaldesc | |
264 Emitted when a conversation is updated. | |
265 @param conv The conversation that was updated. | |
266 @param type The type of update that was made. | |
267 @endsignaldef | |
268 | |
6605 | 269 @signaldef deleting-conversation |
270 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
271 void (*deleting_conversation)(PurpleConversation *conv); |
6605 | 272 @endsignalproto |
273 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
274 Emitted just before a conversation is to be destroyed. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
275 @param conv The conversation that's about to be destroyed. |
6605 | 276 @endsignaldef |
277 | |
278 @signaldef buddy-typing | |
279 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
280 void (*buddy_typing)(PurpleAccount *account, const char *name); |
6605 | 281 @endsignalproto |
282 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
283 Emitted when a buddy starts typing in a conversation window. |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
284 @param account The account of the user which is typing. |
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
285 @param name The name of the user which is typing. |
6605 | 286 @endsignaldef |
287 | |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
288 @signaldef buddy-typing-stopped |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
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 (*buddy_typing_stopped)(PurpleAccount *account, const char *name); |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
291 @endsignalproto |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
292 @signaldesc |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
293 Emitted when a buddy stops typing in a conversation window. |
11707
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
294 @param account The account of the user which stopped typing. |
b7af9100af6c
[gaim-migrate @ 13998]
Richard Laager <rlaager@wiktel.com>
parents:
11474
diff
changeset
|
295 @param name The name of the user which stopped typing. |
6838
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
296 @endsignaldef |
551a8111977a
[gaim-migrate @ 7383]
Christian Hammond <chipx86@chipx86.com>
parents:
6781
diff
changeset
|
297 |
6605 | 298 @signaldef chat-buddy-joining |
299 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
300 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
|
301 PurpleConvChatBuddyFlags flags); |
6605 | 302 @endsignalproto |
303 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
304 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
|
305 users in the chat updates to include the new user. |
9587 | 306 @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
|
307 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
308 @param name The name of the user that is joining the conversation. |
9554 | 309 @param flags The flags of the user that is joining the conversation. |
6605 | 310 @endsignaldef |
311 | |
312 @signaldef chat-buddy-joined | |
313 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
314 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
|
315 PurpleConvChatBuddyFlags flags, |
12850
49b2347863b2
[gaim-migrate @ 15200]
Richard Laager <rlaager@wiktel.com>
parents:
12639
diff
changeset
|
316 gboolean new_arrival); |
6605 | 317 @endsignalproto |
318 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
319 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
|
320 @param conv The chat conversation. |
9554 | 321 @param name The name of the user that has joined the conversation. |
322 @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
|
323 @param new_arrival If the buddy is a new arrival. |
9554 | 324 @endsignaldef |
325 | |
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
|
326 @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
|
327 @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
|
328 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
|
329 @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
|
330 @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
|
331 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
|
332 @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
|
333 @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
|
334 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
|
335 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
|
336 @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
|
337 |
9554 | 338 @signaldef chat-buddy-flags |
339 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
340 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
|
341 PurpleConvChatBuddyFlags oldflags, |
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
342 PurpleConvChatBuddyFlags newflags); |
9554 | 343 @endsignalproto |
344 @signaldesc | |
345 Emitted when a user in a chat changes flags. | |
346 @param conv The chat conversation. | |
347 @param name The name of the user. | |
348 @param oldflags The old flags. | |
349 @param newflags The new flags. | |
6605 | 350 @endsignaldef |
351 | |
352 @signaldef chat-buddy-leaving | |
353 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
354 gboolean (*chat_buddy_leaving)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
355 const char *reason); |
6605 | 356 @endsignalproto |
357 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
358 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
|
359 This may include an optional reason why the user is leaving. |
9587 | 360 @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
|
361 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
362 @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
|
363 @param reason The optional reason why the user is leaving. |
6605 | 364 @endsignaldef |
365 | |
366 @signaldef chat-buddy-left | |
367 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
368 void (*chat_buddy_left)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
369 const char *reason); |
6605 | 370 @endsignalproto |
371 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
372 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
|
373 This may include an optional reason why the user is leaving. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
374 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
375 @param name The name of the user that left the chat. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
376 @param reason The optional reason why the user left the chat. |
6605 | 377 @endsignaldef |
378 | |
379 @signaldef chat-inviting-user | |
380 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
381 void (*chat_inviting_user)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
382 char **invite_message); |
6605 | 383 @endsignalproto |
384 @signaldesc | |
6608
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
385 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
|
386 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
|
387 the invite message. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
388 @note |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
389 Make sure to free @a *invite_message before you replace it! |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
390 @param conv The chat conversation. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
391 @param name The name of the user being invited. |
bc219e9efb9a
[gaim-migrate @ 7132]
Christian Hammond <chipx86@chipx86.com>
parents:
6606
diff
changeset
|
392 @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
|
393 invited. |
6605 | 394 @endsignaldef |
395 | |
396 @signaldef chat-invited-user | |
397 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
398 void (*chat_invited_user)(PurpleConversation *conv, const char *name, |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
399 const char *invite_message); |
6605 | 400 @endsignalproto |
401 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
402 Emitted when a user invited another user to a chat. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
403 @param conv The chat conversation. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
404 @param conv The name of the user that was invited. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
405 @param invite_message The message to be sent to the user when invited. |
6605 | 406 @endsignaldef |
407 | |
408 @signaldef chat-invited | |
409 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
410 gint (*chat_invited)(PurpleAccount *account, const char *inviter, |
9514 | 411 const char *chat, const char *invite_message |
11474
7e9635b73ed6
[gaim-migrate @ 13715]
Gary Kramlich <grim@reaperworld.com>
parents:
11064
diff
changeset
|
412 const GHashTable *components); |
6605 | 413 @endsignalproto |
414 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
415 Emitted when an account was invited to a chat. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
416 @param account The account being invited. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
417 @param inviter The username of the person inviting the account. |
9484 | 418 @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
|
419 @param invite_message The optional invite message. |
9514 | 420 @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
|
421 serv_join_chat() |
11064
e4459e8ccfb5
[gaim-migrate @ 13035]
Richard Laager <rlaager@wiktel.com>
parents:
10104
diff
changeset
|
422 @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
|
423 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
|
424 default behavior will be maintained: the user will be prompted. |
6605 | 425 @endsignaldef |
426 | |
23171
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
427 @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
|
428 @signalproto |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
429 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
|
430 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
|
431 @endsignalproto |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
432 @signaldesc |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
433 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
|
434 @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
|
435 @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
|
436 @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
|
437 @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
|
438 @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
|
439 @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
|
440 @endsignaldef |
ff8ec3d58367
Modified patch from Stefan 'cockroach' Ott to add blocked-im-msg and
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
23105
diff
changeset
|
441 |
6605 | 442 @signaldef chat-joined |
443 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
444 void (*chat_joined)(PurpleConversation *conv); |
6605 | 445 @endsignalproto |
446 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
447 Emitted when an account joins a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
448 @param conv The conversation that joined the chat room. |
6605 | 449 @endsignaldef |
450 | |
451 @signaldef chat-left | |
452 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
453 void (*chat_left)(PurpleConversation *conv); |
6605 | 454 @endsignalproto |
455 @signaldesc | |
6609
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
456 Emitted when an account leaves a chat room. |
d470295a4945
[gaim-migrate @ 7133]
Christian Hammond <chipx86@chipx86.com>
parents:
6608
diff
changeset
|
457 @param conv The conversation that left the chat room. |
6605 | 458 @endsignaldef |
459 | |
9517 | 460 @signaldef chat-topic-changed |
461 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13251
diff
changeset
|
462 void (*chat_topic_changed)(PurpleConversation *conv, const char *who, const char *topic); |
9517 | 463 @endsignalproto |
464 @signaldesc | |
465 Emitted when the topic is changed in a chat. | |
466 @param conv The conversation whose topic changed. | |
467 @param who The name of the person that changed the topic. | |
468 @param topic The new topic. | |
469 @endsignaldef | |
470 | |
17220
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
471 @signaldef conversation-extended-menu |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
472 @signalproto |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
473 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
|
474 @endsignalproto |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
475 @signaldesc |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
476 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
|
477 conversation. |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
478 @param conv The conversation. |
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
479 @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
|
480 @since 2.1.0 |
17220
da2bab3b9fab
New api function purple_conversation_get_extended_menu.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16201
diff
changeset
|
481 @endsignaldef |
30180
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
482 |
31894
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
483 @signaldef cleared-message-history |
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
484 @signalproto |
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
485 void (*cleared_message_history)(PurpleConversation *conv); |
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
486 @endsignalproto |
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
487 @signaldesc |
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
488 Emitted when the conversation history is cleared. |
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
489 @param conv The conversation. |
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
490 @since 2.8.0 |
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
491 @endsignaldef |
a9e077fb65e9
Add a cleared-message-history conversation signal, and use it in Pidgin and Finch
Paul Aurich <paul@darkrain42.org>
parents:
30180
diff
changeset
|
492 |
30180
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
493 @signaldef sent-attention |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
494 @signalproto |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
495 void (*got_attention)(PurpleAccount *account, const char *who, |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
496 PurpleConversation *conv, guint type) |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
497 @endsignalproto |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
498 @signaldesc |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
499 Emitted when receiving an attention message (buzz, nudge, etc.). |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
500 @param account The account |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
501 @param who The name of the person receiving the attention |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
502 @param conv The conversation |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
503 @param type The attention type (an index starting at 0) |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
504 @since 2.7.0 |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
505 @endsignaldef |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
506 |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
507 @signaldef got-attention |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
508 @signalproto |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
509 void (*got_attention)(PurpleAccount *account, const char *who, |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
510 PurpleConversation *conv, guint type) |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
511 @endsignalproto |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
512 @signaldesc |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
513 Emitted when receiving an attention message (buzz, nudge, etc.). |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
514 @param account The account |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
515 @param who The name of the person sending the attention |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
516 @param conv The conversation |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
517 @param type The attention type (an index starting at 0) |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
518 @since 2.7.0 |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
30179
diff
changeset
|
519 @endsignaldef |
6605 | 520 */ |
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
|
521 // vim: syntax=c.doxygen tw=75 et |