1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
|
<?xml version='1.0' encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<chapter id="chapter-signals-gtkconv">
<title>Conversation signals</title>
<refsect1 id="gtkconvs.signals" role="signal_proto">
<title role="signal_proto.title">List of signals</title>
<synopsis>
"<link linkend="gtkconvs-conversation-dragging">conversation-dragging</link>"
"<link linkend="gtkconvs-displaying-im-msg">displaying-im-msg</link>"
"<link linkend="gtkconvs-displayed-im-msg">displayed-im-msg</link>"
"<link linkend="gtkconvs-displaying-chat-msg">displaying-chat-msg</link>"
"<link linkend="gtkconvs-displayed-chat-msg">displayed-chat-msg</link>"
"<link linkend="gtkconvs-conversation-switched">conversation-switched</link>"
"<link linkend="gtkconvs-conversation-hiding">conversation-hiding</link>"
"<link linkend="gtkconvs-conversation-displayed">conversation-displayed</link>"
</synopsis>
</refsect1>
<refsect1 id="gtkconvs.signal-details" role="signals">
<title role="signals.title">Signal details</title>
<refsect2 id="gtkconvs-conversation-dragging" role="signal">
<title>The <literal>"conversation-dragging"</literal> signal</title>
<programlisting>
void user_function (PidginWindow *source,
PidginWindow *destination,
gpointer user_data)
</programlisting>
<para>
Emitted when a conversation is being drag and dropped between windows.
</para>
<variablelist role="params">
<varlistentry>
<term><parameter>source</parameter> :</term>
<listitem><simpara>The window where the conversation is.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>destination</parameter> :</term>
<listitem><simpara>The window where the conversation will be moved to.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gtkconvs-displaying-im-msg" role="signal">
<title>The <literal>"displaying-im-msg"</literal> signal</title>
<programlisting>
gboolean user_function (PurpleAccount *account,
const char *who,
char **message,
PurpleConversation *conv,
PurpleMessageFlags flags,
gpointer user_data)
</programlisting>
<para>
Emitted just before a message is displayed in an IM conversation. <literal>message</literal> is a pointer to a string, so the plugin can replace the message that will be displayed. This can also be used to cancel displaying a message by returning <literal>TRUE</literal>.
</para>
<note><para>
Make sure to free <literal>*message</literal> before you replace it!
</para></note>
<variablelist role="params">
<varlistentry>
<term><parameter>account</parameter> :</term>
<listitem><simpara>The account.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>who</parameter> :</term>
<listitem><simpara>The name of the user.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter> :</term>
<listitem><simpara>A pointer to the message.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>conv</parameter> :</term>
<listitem><simpara>The conversation.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter> :</term>
<listitem><simpara>Flags for this message.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>TRUE</literal> if the message should be canceled, or <literal>FALSE</literal> otherwise.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gtkconvs-displayed-im-msg" role="signal">
<title>The <literal>"displayed-im-msg"</literal> signal</title>
<programlisting>
void user_function (PurpleAccount *account,
const char *who,
char *message,
PurpleConversation *conv,
PurpleMessageFlags flags,
gpointer user_data)
</programlisting>
<para>
Emitted after a message is displayed in an IM conversation.
</para>
<variablelist role="params">
<varlistentry>
<term><parameter>account</parameter> :</term>
<listitem><simpara>The account.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>who</parameter> :</term>
<listitem><simpara>The name of the user.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter> :</term>
<listitem><simpara>The message.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>conv</parameter> :</term>
<listitem><simpara>The conversation.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter> :</term>
<listitem><simpara>Flags for this message.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gtkconvs-displaying-chat-msg" role="signal">
<title>The <literal>"displaying-chat-msg"</literal> signal</title>
<programlisting>
gboolean user_function (PurpleAccount *account,
const char *who,
char **message,
PurpleConversation *conv,
PurpleMessageFlags flags,
gpointer user_data)
</programlisting>
<para>
Emitted just before a message is displayed in a chat. <literal>message</literal> is a pointer to a string, so the plugin can replace the message that will be displayed. This can also be used to cancel displaying a message by returning <literal>TRUE</literal>.
</para>
<note><para>
Make sure to free <literal>*message</literal> before you replace it!
</para></note>
<variablelist role="params">
<varlistentry>
<term><parameter>account</parameter> :</term>
<listitem><simpara>The account the message is being displayed and sent on.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>who</parameter> :</term>
<listitem><simpara>The name of the user.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter> :</term>
<listitem><simpara>A pointer to the message that will be displayed and sent.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>conv</parameter> :</term>
<listitem><simpara>The conversation the message is being displayed and sent on.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter> :</term>
<listitem><simpara>Flags for this message.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>TRUE</literal> if the message should be canceled, or <literal>FALSE</literal> otherwise.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gtkconvs-displayed-chat-msg" role="signal">
<title>The <literal>"displayed-chat-msg"</literal> signal</title>
<programlisting>
void user_function (PurpleAccount *account,
const char *who,
char *message,
PurpleConversation *conv,
PurpleMessageFlags flags,
gpointer user_data)
</programlisting>
<para>
Emitted after a message is displayed in a chat conversation.
</para>
<variablelist role="params">
<varlistentry>
<term><parameter>account</parameter> :</term>
<listitem><simpara>The account the message is being displayed and sent on.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>who</parameter> :</term>
<listitem><simpara>The name of the user.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter> :</term>
<listitem><simpara>A pointer to the message that will be displayed and sent.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>conv</parameter> :</term>
<listitem><simpara>The conversation the message is being displayed and sent on.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter> :</term>
<listitem><simpara>Flags for this message.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gtkconvs-conversation-switched" role="signal">
<title>The <literal>"conversation-switched"</literal> signal</title>
<programlisting>
void user_function (PurpleConversation *conv,
gpointer user_data)
</programlisting>
<para>
Emitted when a window switched from one conversation to another.
</para>
<variablelist role="params">
<varlistentry>
<term><parameter>new_conv</parameter> :</term>
<listitem><simpara>The now active conversation.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gtkconvs-conversation-hiding" role="signal">
<title>The <literal>"conversation-hiding"</literal> signal</title>
<programlisting>
void user_function (PidginConversation *gtkconv,
gpointer user_data)
</programlisting>
<para>
Emitted immediately before an existing conversation is hidden.
</para>
<variablelist role="params">
<varlistentry>
<term><parameter>gtkconv</parameter> :</term>
<listitem><simpara>The PidginConversation.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gtkconvs-conversation-displayed" role="signal">
<title>The <literal>"conversation-displayed"</literal> signal</title>
<programlisting>
void user_function (PidginConversation *gtkconv,
gpointer user_data)
</programlisting>
<para>
Emitted right after the Pidgin UI is attached to a new or a hidden conversation.
</para>
<variablelist role="params">
<varlistentry>
<term><parameter>gtkconv</parameter> :</term>
<listitem><simpara>The PidginConversation.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</chapter>
|
