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
|
<refentry id="gsf-Zip">
<refmeta>
<refentrytitle role="top_of_page">Zip</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GSF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Zip</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="GsfInfileZip"/><anchor id="GsfOutfileZip"/>
<synopsis>
<link linkend="GsfInfileZip-struct">GsfInfileZip</link>;
<link linkend="GsfInfile">GsfInfile</link>* <link linkend="gsf-infile-zip-new">gsf_infile_zip_new</link> (<link linkend="GsfInput">GsfInput</link> *source,
<link linkend="GError">GError</link> **err);
<link linkend="GsfOutfileZip-struct">GsfOutfileZip</link>;
<link linkend="GsfOutfile">GsfOutfile</link>* <link linkend="gsf-outfile-zip-new">gsf_outfile_zip_new</link> (<link linkend="GsfOutput">GsfOutput</link> *sink,
<link linkend="GError">GError</link> **err);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-outfile-zip-set-compression-method">gsf_outfile_zip_set_compression_method</link>
(<link linkend="GsfOutfileZip">GsfOutfileZip</link> *zip,
<link linkend="GsfZipCompressionMethod">GsfZipCompressionMethod</link> method);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GsfInput">GsfInput</link>
+----<link linkend="GsfInfile">GsfInfile</link>
+----GsfInfileZip
</synopsis>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GsfOutput">GsfOutput</link>
+----<link linkend="GsfOutfile">GsfOutfile</link>
+----GsfOutfileZip
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GsfInfileZip--compression-level">compression-level</link>" <link linkend="gint">gint</link> : Read
"<link linkend="GsfInfileZip--internal-parent">internal-parent</link>" <link linkend="GsfInfileZip">GsfInfileZip</link> : Write / Construct Only
"<link linkend="GsfInfileZip--source">source</link>" <link linkend="GsfInput">GsfInput</link> : Read / Write / Construct Only
"<link linkend="GsfOutfileZip--compression-level">compression-level</link>" <link linkend="gint">gint</link> : Read / Write / Construct Only
"<link linkend="GsfOutfileZip--entry-name">entry-name</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
"<link linkend="GsfOutfileZip--sink">sink</link>" <link linkend="GsfOutput">GsfOutput</link> : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GsfInfileZip-struct" role="struct"/>GsfInfileZip</title>
<indexterm><primary>GsfInfileZip</primary></indexterm><programlisting>typedef struct _GsfInfileZip GsfInfileZip;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-infile-zip-new" role="function"/>gsf_infile_zip_new ()</title>
<indexterm><primary>gsf_infile_zip_new</primary></indexterm><programlisting><link linkend="GsfInfile">GsfInfile</link>* gsf_infile_zip_new (<link linkend="GsfInput">GsfInput</link> *source,
<link linkend="GError">GError</link> **err);</programlisting>
<para>
Opens the root directory of a Zip file.
<note>This adds a reference to <parameter>source</parameter>.</note></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> A base <link linkend="GsfInput"><type>GsfInput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter> :</term>
<listitem><simpara> A <link linkend="GError"><type>GError</type></link>, optionally <link linkend="null"><literal>null</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new zip file handler
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GsfOutfileZip-struct" role="struct"/>GsfOutfileZip</title>
<indexterm><primary>GsfOutfileZip</primary></indexterm><programlisting>typedef struct _GsfOutfileZip GsfOutfileZip;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-outfile-zip-new" role="function"/>gsf_outfile_zip_new ()</title>
<indexterm><primary>gsf_outfile_zip_new</primary></indexterm><programlisting><link linkend="GsfOutfile">GsfOutfile</link>* gsf_outfile_zip_new (<link linkend="GsfOutput">GsfOutput</link> *sink,
<link linkend="GError">GError</link> **err);</programlisting>
<para>
Creates the root directory of a Zip file and manages the addition of
children.
</para>
<para>
<note>This adds a reference to <parameter>sink</parameter>.</note></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>sink</parameter> :</term>
<listitem><simpara> a <link linkend="GsfOutput"><type>GsfOutput</type></link> to hold the ZIP file
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter> :</term>
<listitem><simpara> Location to store error, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>; currently unused.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new zip file handler
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-outfile-zip-set-compression-method" role="function"/>gsf_outfile_zip_set_compression_method ()</title>
<indexterm><primary>gsf_outfile_zip_set_compression_method</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_outfile_zip_set_compression_method
(<link linkend="GsfOutfileZip">GsfOutfileZip</link> *zip,
<link linkend="GsfZipCompressionMethod">GsfZipCompressionMethod</link> method);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>zip</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>method</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GsfInfileZip--compression-level"/>The "<literal>compression-level</literal>" property</title>
<indexterm><primary>GsfInfileZip:compression-level</primary></indexterm><programlisting> "compression-level" <link linkend="gint">gint</link> : Read</programlisting>
<para>The level of compression used, zero meaning none.</para><para>Allowed values: [0,10]</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="GsfInfileZip--internal-parent"/>The "<literal>internal-parent</literal>" property</title>
<indexterm><primary>GsfInfileZip:internal-parent</primary></indexterm><programlisting> "internal-parent" <link linkend="GsfInfileZip">GsfInfileZip</link> : Write / Construct Only</programlisting>
<para>Internal use only.</para></refsect2>
<refsect2><title><anchor id="GsfInfileZip--source"/>The "<literal>source</literal>" property</title>
<indexterm><primary>GsfInfileZip:source</primary></indexterm><programlisting> "source" <link linkend="GsfInput">GsfInput</link> : Read / Write / Construct Only</programlisting>
<para>The archive being interpreted.</para></refsect2>
<refsect2><title><anchor id="GsfOutfileZip--compression-level"/>The "<literal>compression-level</literal>" property</title>
<indexterm><primary>GsfOutfileZip:compression-level</primary></indexterm><programlisting> "compression-level" <link linkend="gint">gint</link> : Read / Write / Construct Only</programlisting>
<para>The level of compression used, zero meaning none.</para><para>Allowed values: [0,10]</para>
<para>Default value: 8</para>
</refsect2>
<refsect2><title><anchor id="GsfOutfileZip--entry-name"/>The "<literal>entry-name</literal>" property</title>
<indexterm><primary>GsfOutfileZip:entry-name</primary></indexterm><programlisting> "entry-name" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
<para>The filename of this member in the archive without path.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GsfOutfileZip--sink"/>The "<literal>sink</literal>" property</title>
<indexterm><primary>GsfOutfileZip:sink</primary></indexterm><programlisting> "sink" <link linkend="GsfOutput">GsfOutput</link> : Read / Write / Construct Only</programlisting>
<para>Where the archive is written.</para></refsect2>
</refsect1>
</refentry>
|
