6605
|
1 /** @page conversation-signals Conversation Signals
|
|
2
|
|
3 @signals
|
|
4 @signal displaying-im-msg
|
|
5 @signal displayed-im-msg
|
|
6 @signal sending-im-msg
|
|
7 @signal sent-im-msg
|
|
8 @signal received-im-msg
|
|
9 @signal displaying-chat-msg
|
|
10 @signal displayed-chat-msg
|
|
11 @signal sending-chat-msg
|
|
12 @signal sent-chat-msg
|
|
13 @signal received-chat-msg
|
|
14 @signal conversation-switching
|
|
15 @signal conversation-switched
|
|
16 @signal conversation-created
|
|
17 @signal deleting-conversation
|
|
18 @signal buddy-typing
|
|
19 @signal chat-buddy-joining
|
|
20 @signal chat-buddy-joined
|
|
21 @signal chat-buddy-leaving
|
|
22 @signal chat-buddy-left
|
|
23 @signal chat-inviting-user
|
|
24 @signal chat-invited-user
|
|
25 @signal chat-invited
|
|
26 @signal chat-joined
|
|
27 @signal chat-left
|
|
28 @endsignals
|
|
29
|
|
30 @signaldef displaying-im-msg
|
|
31 @signalproto
|
|
32 gboolean (*displaying_im_msg)(GaimAccount *account, char **message);
|
|
33 @endsignalproto
|
|
34 @param account The account the message is being displayed on.
|
|
35 @param message A pointer to the message that will be displayed.
|
|
36 @signaldesc
|
|
37 Emitted just before a message is displayed in an IM conversation.
|
|
38 @a message is a pointer to a string, so the plugin can replace the
|
|
39 message that will be displayed. This can also be used to cancel displaying
|
|
40 a message by returning @c TRUE.
|
|
41 @note
|
|
42 Make sure to free @a *message before you replace it!
|
|
43 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
|
|
44 @endsignaldef
|
|
45
|
|
46 @signaldef displayed-im-msg
|
|
47 @signalproto
|
|
48 void (*displayed_im_msg)(GaimAccount *account, const char *message);
|
|
49 @endsignalproto
|
|
50 @param account The account the message was displayed on.
|
|
51 @param message The message that was displayed.
|
|
52 @signaldesc
|
|
53 Emitted after a message is displayed in an IM conversation.
|
|
54 @endsignaldef
|
|
55
|
|
56 @signaldef sending-im-msg
|
|
57 @signalproto
|
|
58 void (*sending_im_msg)(GaimAccount *account, const char *receiver, char **message);
|
|
59 @endsignalproto
|
|
60 @param conv The account the message is being sent on.
|
|
61 @param receiver The username of the receiver.
|
|
62 @param message A pointer to the outgoing message. This can be modified.
|
|
63 @signaldesc
|
|
64 Emitted before sending an IM to a user. @a message is a pointer to the
|
|
65 message string, so the plugin can replace the message before being sent.
|
|
66 @note
|
|
67 Make sure to free @a *message before you replace it!
|
|
68 @endsignaldef
|
|
69
|
|
70 @signaldef sent-im-msg
|
|
71 @signalproto
|
|
72 void (*sent_im_msg)(GaimAccount *account, const char *receiver, const char *message);
|
|
73 @endsignalproto
|
|
74 @param account The account the message was sent on.
|
|
75 @param receiver The username of the receiver.
|
|
76 @param message The message that was sent.
|
|
77 @signaldesc
|
|
78 Emitted after sending an IM to a user.
|
|
79 @endsignaldef
|
|
80
|
|
81 @signaldef received-im-msg
|
|
82 @signalproto
|
|
83 gboolean (*received_im_msg)(GaimAccount *account, char **sender, char **message, int *flags);
|
|
84 @endsignalproto
|
|
85 @param account The account the message was received on.
|
|
86 @param sender A pointer to the username of the sender.
|
|
87 @param message A pointer to the message that was sent.
|
|
88 @signaldesc
|
|
89 Emitted when an IM is received. The callback can replace the name of the
|
|
90 sender, the message, or the flags by modifying the pointer to the
|
|
91 strings and integer. This can also be used to cancel a message by
|
|
92 returning @c TRUE.
|
|
93 @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
|
|
94 @endsignaldef
|
|
95
|
|
96 @signaldef displaying-chat-msg
|
|
97 @signalproto
|
|
98 void (*displaying-chat-msg)(GaimConversation *conv);
|
|
99 @endsignalproto
|
|
100 @param conv The conversation.
|
|
101 @signaldesc
|
|
102
|
|
103 @endsignaldef
|
|
104
|
|
105 @signaldef displayed-chat-msg
|
|
106 @signalproto
|
|
107 void (*displayed-chat-msg)(GaimConversation *conv);
|
|
108 @endsignalproto
|
|
109 @param conv The conversation.
|
|
110 @signaldesc
|
|
111
|
|
112 @endsignaldef
|
|
113
|
|
114 @signaldef sending-chat-msg
|
|
115 @signalproto
|
|
116 void (*sending-chat-msg)(GaimConversation *conv);
|
|
117 @endsignalproto
|
|
118 @param conv The conversation.
|
|
119 @signaldesc
|
|
120
|
|
121 @endsignaldef
|
|
122
|
|
123 @signaldef sent-chat-msg
|
|
124 @signalproto
|
|
125 void (*sent-chat-msg)(GaimConversation *conv);
|
|
126 @endsignalproto
|
|
127 @param conv The conversation.
|
|
128 @signaldesc
|
|
129
|
|
130 @endsignaldef
|
|
131
|
|
132 @signaldef received-chat-msg
|
|
133 @signalproto
|
|
134 void (*received-chat-msg)(GaimConversation *conv);
|
|
135 @endsignalproto
|
|
136 @param conv The conversation.
|
|
137 @signaldesc
|
|
138
|
|
139 @endsignaldef
|
|
140
|
|
141 @signaldef conversation-switching
|
|
142 @signalproto
|
|
143 void (*conversation-switching)(GaimConversation *conv);
|
|
144 @endsignalproto
|
|
145 @param conv The conversation.
|
|
146 @signaldesc
|
|
147
|
|
148 @endsignaldef
|
|
149
|
|
150 @signaldef conversation-switched
|
|
151 @signalproto
|
|
152 void (*conversation-switched)(GaimConversation *conv);
|
|
153 @endsignalproto
|
|
154 @param conv The conversation.
|
|
155 @signaldesc
|
|
156
|
|
157 @endsignaldef
|
|
158
|
|
159 @signaldef conversation-created
|
|
160 @signalproto
|
|
161 void (*conversation-created)(GaimConversation *conv);
|
|
162 @endsignalproto
|
|
163 @param conv The conversation.
|
|
164 @signaldesc
|
|
165
|
|
166 @endsignaldef
|
|
167
|
|
168 @signaldef deleting-conversation
|
|
169 @signalproto
|
|
170 void (*deleting-conversation)(GaimConversation *conv);
|
|
171 @endsignalproto
|
|
172 @param conv The conversation.
|
|
173 @signaldesc
|
|
174
|
|
175 @endsignaldef
|
|
176
|
|
177 @signaldef buddy-typing
|
|
178 @signalproto
|
|
179 void (*buddy-typing)(GaimConversation *conv);
|
|
180 @endsignalproto
|
|
181 @param conv The conversation.
|
|
182 @signaldesc
|
|
183
|
|
184 @endsignaldef
|
|
185
|
|
186 @signaldef chat-buddy-joining
|
|
187 @signalproto
|
|
188 void (*chat-buddy-joining)(GaimConversation *conv);
|
|
189 @endsignalproto
|
|
190 @param conv The conversation.
|
|
191 @signaldesc
|
|
192
|
|
193 @endsignaldef
|
|
194
|
|
195 @signaldef chat-buddy-joined
|
|
196 @signalproto
|
|
197 void (*chat-buddy-joined)(GaimConversation *conv);
|
|
198 @endsignalproto
|
|
199 @param conv The conversation.
|
|
200 @signaldesc
|
|
201
|
|
202 @endsignaldef
|
|
203
|
|
204 @signaldef chat-buddy-leaving
|
|
205 @signalproto
|
|
206 void (*chat-buddy-leaving)(GaimConversation *conv);
|
|
207 @endsignalproto
|
|
208 @param conv The conversation.
|
|
209 @signaldesc
|
|
210
|
|
211 @endsignaldef
|
|
212
|
|
213 @signaldef chat-buddy-left
|
|
214 @signalproto
|
|
215 void (*chat-buddy-left)(GaimConversation *conv);
|
|
216 @endsignalproto
|
|
217 @param conv The conversation.
|
|
218 @signaldesc
|
|
219
|
|
220 @endsignaldef
|
|
221
|
|
222 @signaldef chat-inviting-user
|
|
223 @signalproto
|
|
224 void (*chat-inviting-user)(GaimConversation *conv);
|
|
225 @endsignalproto
|
|
226 @param conv The conversation.
|
|
227 @signaldesc
|
|
228
|
|
229 @endsignaldef
|
|
230
|
|
231 @signaldef chat-invited-user
|
|
232 @signalproto
|
|
233 void (*chat-invited-user)(GaimConversation *conv);
|
|
234 @endsignalproto
|
|
235 @param conv The conversation.
|
|
236 @signaldesc
|
|
237
|
|
238 @endsignaldef
|
|
239
|
|
240 @signaldef chat-invited
|
|
241 @signalproto
|
|
242 void (*chat-invited)(GaimConversation *conv);
|
|
243 @endsignalproto
|
|
244 @param conv The conversation.
|
|
245 @signaldesc
|
|
246
|
|
247 @endsignaldef
|
|
248
|
|
249 @signaldef chat-joined
|
|
250 @signalproto
|
|
251 void (*chat-joined)(GaimConversation *conv);
|
|
252 @endsignalproto
|
|
253 @param conv The conversation.
|
|
254 @signaldesc
|
|
255
|
|
256 @endsignaldef
|
|
257
|
|
258 @signaldef chat-left
|
|
259 @signalproto
|
|
260 void (*chat-left)(GaimConversation *conv);
|
|
261 @endsignalproto
|
|
262 @param conv The conversation.
|
|
263 @signaldesc
|
|
264
|
|
265 @endsignaldef
|
|
266
|
|
267 */
|
|
268 // vim: syntax=c tw=75 et
|