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