doc/reference/libpurple/signals_xfer.xml

Fri, 31 Jan 2014 18:02:20 +0530

author
Ankit Vani <a@nevitus.org>
date
Fri, 31 Jan 2014 18:02:20 +0530
branch
soc.2013.gobjectification.plugins
changeset 37033
ce8b96a22ebe
parent 36919
ca118d6cc20f
parent 35389
884a5385bb2c
child 40254
09402b6a28cf
permissions
-rw-r--r--

Merge gtkdoc-conversion

35389
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
1 <?xml version='1.0' encoding="ISO-8859-1"?>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
4 ]>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
5 <chapter id="chapter-signals-xfer">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
6 <title>File Transfer signals</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
7
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
8 <refsect1 id="xfers.signals" role="signal_proto">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
9 <title role="signal_proto.title">List of signals</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
10 <synopsis>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
11 &quot;<link linkend="xfers-file-recv-accept">file-recv-accept</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
12 &quot;<link linkend="xfers-file-recv-start">file-recv-start</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
13 &quot;<link linkend="xfers-file-recv-cancel">file-recv-cancel</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
14 &quot;<link linkend="xfers-file-recv-complete">file-recv-complete</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
15 &quot;<link linkend="xfers-file-recv-request">file-recv-request</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
16 &quot;<link linkend="xfers-file-send-accept">file-send-accept</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
17 &quot;<link linkend="xfers-file-send-start">file-send-start</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
18 &quot;<link linkend="xfers-file-send-cancel">file-send-cancel</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
19 &quot;<link linkend="xfers-file-send-complete">file-send-complete</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
20 </synopsis>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
21 </refsect1>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
22
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
23 <refsect1 id="xfers.signal-details" role="signals">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
24 <title role="signals.title">Signal details</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
25
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
26 <refsect2 id="xfers-file-recv-accept" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
27 <title>The <literal>&quot;file-recv-accept&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
28 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
29 void user_function (PurpleXfer *xfer,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
30 gpointer data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
31 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
32 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
33 Emitted when an incoming file transfer has been accepted.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
34 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
35 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
36 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
37 <term><parameter>xfer</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
38 <listitem><simpara>The file transfer.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
39 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
40 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
41 <term><parameter>data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
42 <listitem><simpara>User data.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
43 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
44 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
45 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
46
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
47 <refsect2 id="xfers-file-recv-start" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
48 <title>The <literal>&quot;file-recv-start&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
49 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
50 void user_function (PurpleXfer *xfer,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
51 gpointer data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
52 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
53 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
54 Emitted when an incoming file transfer has been started.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
55 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
56 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
57 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
58 <term><parameter>xfer</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
59 <listitem><simpara>The file transfer.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
60 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
61 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
62 <term><parameter>data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
63 <listitem><simpara>User data.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
64 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
65 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
66 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
67
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
68 <refsect2 id="xfers-file-recv-cancel" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
69 <title>The <literal>&quot;file-recv-cancel&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
70 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
71 void user_function (PurpleXfer *xfer,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
72 gpointer data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
73 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
74 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
75 Emitted when an incoming file transfer has been canceled.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
76 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
77 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
78 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
79 <term><parameter>xfer</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
80 <listitem><simpara>The file transfer.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
81 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
82 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
83 <term><parameter>data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
84 <listitem><simpara>User data.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
85 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
86 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
87 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
88
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
89 <refsect2 id="xfers-file-recv-complete" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
90 <title>The <literal>&quot;file-recv-complete&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
91 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
92 void user_function (PurpleXfer *xfer,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
93 gpointer data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
94 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
95 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
96 Emitted when an incoming file transfer has been completed.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
97 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
98 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
99 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
100 <term><parameter>xfer</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
101 <listitem><simpara>The file transfer.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
102 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
103 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
104 <term><parameter>data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
105 <listitem><simpara>User data.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
106 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
107 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
108 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
109
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
110 <refsect2 id="xfers-file-recv-request" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
111 <title>The <literal>&quot;file-recv-request&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
112 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
113 void user_function (PurpleXfer *xfer,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
114 gpointer data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
115 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
116 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
117 Emitted before the user is prompted for an incoming file-transfer. Plugins can intercept the signal to auto-accept/auto-reject the requests. To auto-accept the file transfer, use purple_xfer_request_accepted(). To auto-reject, set the status of the xfer to PURPLE_XFER_STATUS_CANCEL_LOCAL.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
118 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
119 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
120 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
121 <term><parameter>xfer</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
122 <listitem><simpara>The file transfer.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
123 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
124 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
125 <term><parameter>data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
126 <listitem><simpara>User data.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
127 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
128 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
129 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
130
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
131 <refsect2 id="xfers-file-send-accept" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
132 <title>The <literal>&quot;file-send-accept&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
133 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
134 void user_function (PurpleXfer *xfer,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
135 gpointer data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
136 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
137 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
138 Emitted when an outgoing file transfer has been accepted.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
139 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
140 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
141 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
142 <term><parameter>xfer</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
143 <listitem><simpara>The file transfer.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
144 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
145 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
146 <term><parameter>data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
147 <listitem><simpara>User data.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
148 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
149 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
150 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
151
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
152 <refsect2 id="xfers-file-send-start" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
153 <title>The <literal>&quot;file-send-start&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
154 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
155 void user_function (PurpleXfer *xfer,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
156 gpointer data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
157 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
158 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
159 Emitted when an outgoing file transfer has started.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
160 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
161 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
162 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
163 <term><parameter>xfer</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
164 <listitem><simpara>The file transfer.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
165 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
166 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
167 <term><parameter>data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
168 <listitem><simpara>User data.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
169 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
170 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
171 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
172
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
173 <refsect2 id="xfers-file-send-cancel" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
174 <title>The <literal>&quot;file-send-cancel&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
175 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
176 void user_function (PurpleXfer *xfer,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
177 gpointer data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
178 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
179 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
180 Emitted when an outgoing file transfer has been canceled.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
181 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
182 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
183 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
184 <term><parameter>xfer</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
185 <listitem><simpara>The file transfer.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
186 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
187 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
188 <term><parameter>data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
189 <listitem><simpara>User data.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
190 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
191 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
192 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
193
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
194 <refsect2 id="xfers-file-send-complete" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
195 <title>The <literal>&quot;file-send-complete&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
196 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
197 void user_function (PurpleXfer *xfer,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
198 gpointer data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
199 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
200 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
201 Emitted when an outgoing file transfer has been completed.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
202 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
203 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
204 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
205 <term><parameter>xfer</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
206 <listitem><simpara>The file transfer.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
207 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
208 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
209 <term><parameter>data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
210 <listitem><simpara>User data.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
211 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
212 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
213 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
214
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
215 </refsect1>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
216
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
217 </chapter>

mercurial