RubyGems - gsf - Versions diffs - 3.0.9-x64-mingw32 - Mend

gsf 3.0.9-x64-mingw32

Files changed (166) hide show

data/vendor/local/share/gtk-doc/html/gsf/gsf-Compression.html ADDED Viewed

@@ -0,0 +1,369 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GSF Reference Manual: Compression</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="GSF Reference Manual">
+<link rel="up" href="parsers.html" title="Stream Parsers">
+<link rel="prev" href="gsf-Zip.html" title="Zip files">
+<link rel="next" href="gsf-MS-OLE2.html" title="MS OLE2">
+<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
+                  <a href="#gsf-Compression.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
+                  <a href="#gsf-Compression.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
+                  <a href="#gsf-Compression.properties" class="shortcut">Properties</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="parsers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="gsf-Zip.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="gsf-MS-OLE2.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="gsf-Compression"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="gsf-Compression.top_of_page"></a>Compression</span></h2>
+<p>Compression</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="gsf-Compression.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Compression.html#gsf-input-gzip-new" title="gsf_input_gzip_new ()">gsf_input_gzip_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Compression.html#gsf-input-memory-new-from-bzip" title="gsf_input_memory_new_from_bzip ()">gsf_input_memory_new_from_bzip</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Compression.html#gsf-output-gzip-new" title="gsf_output_gzip_new ()">gsf_output_gzip_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Compression.html#gsf-output-bzip-new" title="gsf_output_bzip_new ()">gsf_output_bzip_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-Compression.properties"></a><h2>Properties</h2>
+<div class="informaltable"><table border="0">
+<colgroup>
+<col width="150px" class="properties_type">
+<col width="300px" class="properties_name">
+<col width="200px" class="properties_flags">
+</colgroup>
+<tbody>
+<tr>
+<td class="property_type"><span class="type">gboolean</span></td>
+<td class="property_name"><a class="link" href="gsf-Compression.html#GsfInputGZip--raw" title="The “raw” property">raw</a></td>
+<td class="property_flags">Read / Write / Construct Only</td>
+</tr>
+<tr>
+<td class="property_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *</td>
+<td class="property_name"><a class="link" href="gsf-Compression.html#GsfInputGZip--source" title="The “source” property">source</a></td>
+<td class="property_flags">Read / Write / Construct Only</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">gint64</span></td>
+<td class="property_name"><a class="link" href="gsf-Compression.html#GsfInputGZip--uncompressed-size" title="The “uncompressed-size” property">uncompressed-size</a></td>
+<td class="property_flags">Read / Write / Construct Only</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">gboolean</span></td>
+<td class="property_name"><a class="link" href="gsf-Compression.html#GsfOutputGZip--raw" title="The “raw” property">raw</a></td>
+<td class="property_flags">Read / Write / Construct Only</td>
+</tr>
+<tr>
+<td class="property_type">
+<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</td>
+<td class="property_name"><a class="link" href="gsf-Compression.html#GsfOutputGZip--sink" title="The “sink” property">sink</a></td>
+<td class="property_flags">Read / Write / Construct Only</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<a name="GsfInputGZip"></a><a name="GsfOutputGZip"></a><a name="GsfOutputBzip"></a><div class="refsect1">
+<a name="gsf-Compression.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-Compression.html#GsfInputGZip-struct" title="GsfInputGZip">GsfInputGZip</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-Compression.html#GsfOutputGZip-struct" title="GsfOutputGZip">GsfOutputGZip</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-Compression.html#GsfOutputBzip-struct" title="GsfOutputBzip">GsfOutputBzip</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-Compression.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GObject
+    <span class="lineart">├──</span> <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
+    <span class="lineart">│</span>   <span class="lineart">╰──</span> GsfInputGZip
+    <span class="lineart">╰──</span> <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
+        <span class="lineart">├──</span> GsfOutputBzip
+        <span class="lineart">╰──</span> GsfOutputGZip
+</pre>
+</div>
+<div class="refsect1">
+<a name="gsf-Compression.description"></a><h2>Description</h2>
+<p>
+</p>
+</div>
+<div class="refsect1">
+<a name="gsf-Compression.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gsf-input-gzip-new"></a><h3>gsf_input_gzip_new ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_gzip_new (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
+                    <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
+<p>Adds a reference to <em class="parameter"><code>source</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.6.5.5.11.2.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>source</p></td>
+<td class="parameter_description"><p>The underlying data source.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>err</p></td>
+<td class="parameter_description"><p> place to store a <span class="type">GError</span> if anything goes wrong. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.5.11.2.6"></a><h4>Returns</h4>
+<p> a new file or <code class="literal">NULL</code>.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-memory-new-from-bzip"></a><h3>gsf_input_memory_new_from_bzip ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_memory_new_from_bzip (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
+                                <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.5.5.11.3.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>source</p></td>
+<td class="parameter_description"><p>a <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>err</p></td>
+<td class="parameter_description"><p> place to store a <span class="type">GError</span> if anything goes wrong. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.5.11.3.5"></a><h4>Returns</h4>
+<p> a new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a> or <code class="literal">NULL</code>.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-gzip-new"></a><h3>gsf_output_gzip_new ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
+gsf_output_gzip_new (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>,
+                     <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
+<p>Adds a reference to <em class="parameter"><code>sink</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.6.5.5.11.4.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>sink</p></td>
+<td class="parameter_description"><p>The underlying data source.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>err</p></td>
+<td class="parameter_description"><p>optionally <code class="literal">NULL</code>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.5.11.4.6"></a><h4>Returns</h4>
+<p> a new file or <code class="literal">NULL</code>.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-bzip-new"></a><h3>gsf_output_bzip_new ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
+gsf_output_bzip_new (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>,
+                     <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
+<p>Adds a reference to <em class="parameter"><code>sink</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.6.5.5.11.5.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>sink</p></td>
+<td class="parameter_description"><p>The underlying data source.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>err</p></td>
+<td class="parameter_description"><p>optionally <code class="literal">NULL</code>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.5.11.5.6"></a><h4>Returns</h4>
+<p> a new file or <code class="literal">NULL</code>.</p>
+<p></p>
+</div>
+</div>
+</div>
+<div class="refsect1">
+<a name="gsf-Compression.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="GsfInputGZip-struct"></a><h3>GsfInputGZip</h3>
+<pre class="programlisting">typedef struct _GsfInputGZip GsfInputGZip;</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutputGZip-struct"></a><h3>GsfOutputGZip</h3>
+<pre class="programlisting">typedef struct _GsfOutputGZip GsfOutputGZip;</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutputBzip-struct"></a><h3>GsfOutputBzip</h3>
+<pre class="programlisting">typedef struct _GsfOutputBzip GsfOutputBzip;</pre>
+<p>
+</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="gsf-Compression.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="GsfInputGZip--raw"></a><h3>The <code class="literal">“raw”</code> property</h3>
+<pre class="programlisting">  “raw”                      <span class="type">gboolean</span></pre>
+<p>Whether to read compressed data with no header and no trailer.</p>
+<p>Flags: Read / Write / Construct Only</p>
+<p>Default value: FALSE</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfInputGZip--source"></a><h3>The <code class="literal">“source”</code> property</h3>
+<pre class="programlisting">  “source”                   <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *</pre>
+<p>Where the compressed data comes from.</p>
+<p>Flags: Read / Write / Construct Only</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfInputGZip--uncompressed-size"></a><h3>The <code class="literal">“uncompressed-size”</code> property</h3>
+<pre class="programlisting">  “uncompressed-size”        <span class="type">gint64</span></pre>
+<p>The source's uncompressed size.</p>
+<p>Flags: Read / Write / Construct Only</p>
+<p>Allowed values: &gt;= -1</p>
+<p>Default value: -1</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutputGZip--raw"></a><h3>The <code class="literal">“raw”</code> property</h3>
+<pre class="programlisting">  “raw”                      <span class="type">gboolean</span></pre>
+<p>Whether to write compressed data with no header/tailer.</p>
+<p>Flags: Read / Write / Construct Only</p>
+<p>Default value: FALSE</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutputGZip--sink"></a><h3>The <code class="literal">“sink”</code> property</h3>
+<pre class="programlisting">  “sink”                     <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</pre>
+<p>Where the compressed data is written.</p>
+<p>Flags: Read / Write / Construct Only</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20</div>
+</body>
+</html>