Sophie

Sophie

distrib > Mandriva > 2010.0 > x86_64 > by-pkgid > 7f3e5f74d754b480ec33648905c4afae > files > 118

glibmm2.4-doc-2.22.1-1mdv2010.0.x86_64.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>glibmm: Gio::Seekable Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceGio.html">Gio</a>::<a class="el" href="classGio_1_1Seekable.html">Seekable</a>
  </div>
</div>
<div class="contents">
<h1>Gio::Seekable Class Reference<br/>
<small>
[<a class="el" href="group__Streams.html">Stream Classes</a>]</small>
</h1><!-- doxytag: class="Gio::Seekable" --><!-- doxytag: inherits="Glib::Interface" -->
<p>Stream seeking interface. <a href="#_details">More...</a></p>

<p>Inherits <a class="el" href="classGlib_1_1Interface.html">Glib::Interface</a>.</p>

<p>Inherited by <a class="el" href="classGio_1_1FileInputStream.html">Gio::FileInputStream</a>, <a class="el" href="classGio_1_1FileIOStream.html">Gio::FileIOStream</a>, <a class="el" href="classGio_1_1FileOutputStream.html">Gio::FileOutputStream</a>, <a class="el" href="classGio_1_1MemoryInputStream.html">Gio::MemoryInputStream</a>, and <a class="el" href="classGio_1_1MemoryOutputStream.html">Gio::MemoryOutputStream</a>.</p>
<div class="dynheader">
Collaboration diagram for Gio::Seekable:</div>
<div class="dynsection">
<div class="center"><img src="classGio_1_1Seekable__coll__graph.png" border="0" usemap="#Gio_1_1Seekable_coll__map" alt="Collaboration graph"/></div>
<map name="Gio_1_1Seekable_coll__map" id="Gio_1_1Seekable_coll__map">
<area shape="rect" href="classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="13,160,117,189"/><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="5,83,125,112"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,119,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classGio_1_1Seekable-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#a9b3fcb7df7b3e63b737e5bc5c7e74271">~Seekable</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GSeekable*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#a96176a5c51102b9a2d02f4555f2e048f">gobj</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a96176a5c51102b9a2d02f4555f2e048f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GSeekable*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#ac60caf803ddd50d08115da50ccb149dd">gobj</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ac60caf803ddd50d08115da50ccb149dd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">goffset&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#a3f270a74f487712bb0a89d86a8313987">tell</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells the current position within the stream. <a href="#a3f270a74f487712bb0a89d86a8313987"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#a5dd0a134172ea72595a9c7b2072e0350">can_seek</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests if the stream supports the SeekableIface. <a href="#a5dd0a134172ea72595a9c7b2072e0350"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#aa717d10e2322df67b488657add79c70b">seek</a> (goffset offset, <a class="el" href="group__glibmmEnums.html#gaa3767731311bdba4ef42dc99215e5cda">Glib::SeekType</a> type, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Cancellable.html">Cancellable</a> &gt;&amp; cancellable)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Seeks in the stream by the given <em>offset</em>, modified by <em>type</em>. <a href="#aa717d10e2322df67b488657add79c70b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#a3404742af5d7855f6017578091f432cc">seek</a> (goffset offset, <a class="el" href="group__glibmmEnums.html#gaa3767731311bdba4ef42dc99215e5cda">Glib::SeekType</a> type)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Seeks in the stream by the given <em>offset</em>, modified by <em>type</em> . <a href="#a3404742af5d7855f6017578091f432cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#a961a029a8498e9223ed9c136cfe14597">can_truncate</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests if the stream can be truncated. <a href="#a961a029a8498e9223ed9c136cfe14597"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#aaf0792e6281670ea411cd7c3ef981998">truncate</a> (goffset offset, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Cancellable.html">Cancellable</a> &gt;&amp; cancellable)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Truncates a stream with a given offset. <a href="#aaf0792e6281670ea411cd7c3ef981998"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#a4458c08f1486ce89f8a7f9b49f10eb13">truncate</a> (goffset offset)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Truncates a stream with a given offset. <a href="#a4458c08f1486ce89f8a7f9b49f10eb13"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#ae8a94d31313527ff431cf49ba5af2bd8">add_interface</a> (GType gtype_implementer)</td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Seekable.html">Gio::Seekable</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Seekable.html#a0756ddeb91dc62f76d8a380716ecd228">wrap</a> (GSeekable* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a0756ddeb91dc62f76d8a380716ecd228"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Stream seeking interface. </p>
<p><a class="el" href="classGio_1_1Seekable.html" title="Stream seeking interface.">Seekable</a> is implemented by streams (implementations of <a class="el" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input.">InputStream</a> or <a class="el" href="classGio_1_1OutputStream.html" title="Base class for implementing streaming output.">OutputStream</a>) that support seeking. To find the position of a stream, use <a class="el" href="classGio_1_1Seekable.html#a3f270a74f487712bb0a89d86a8313987" title="Tells the current position within the stream.">tell()</a>. To find out if a stream supports seeking, use <a class="el" href="classGio_1_1Seekable.html#a5dd0a134172ea72595a9c7b2072e0350" title="Tests if the stream supports the SeekableIface.">can_seek()</a>. To position a stream, use <a class="el" href="classGio_1_1Seekable.html#aa717d10e2322df67b488657add79c70b" title="Seeks in the stream by the given offset, modified by type.">seek()</a>. To find out if a stream supports truncating, use <a class="el" href="classGio_1_1Seekable.html#a961a029a8498e9223ed9c136cfe14597" title="Tests if the stream can be truncated.">can_truncate()</a>. To truncate a stream, use <a class="el" href="classGio_1_1Seekable.html#aaf0792e6281670ea411cd7c3ef981998" title="Truncates a stream with a given offset.">truncate()</a>.</p>
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000042">Since glibmm 2.16:</a></b></dt><dd></dd></dl>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9b3fcb7df7b3e63b737e5bc5c7e74271"></a><!-- doxytag: member="Gio::Seekable::~Seekable" ref="a9b3fcb7df7b3e63b737e5bc5c7e74271" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Gio::Seekable::~Seekable </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae8a94d31313527ff431cf49ba5af2bd8"></a><!-- doxytag: member="Gio::Seekable::add_interface" ref="ae8a94d31313527ff431cf49ba5af2bd8" args="(GType gtype_implementer)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void Gio::Seekable::add_interface </td>
          <td>(</td>
          <td class="paramtype">GType&#160;</td>
          <td class="paramname"> <em>gtype_implementer</em></td>
          <td>&#160;)&#160;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a5dd0a134172ea72595a9c7b2072e0350"></a><!-- doxytag: member="Gio::Seekable::can_seek" ref="a5dd0a134172ea72595a9c7b2072e0350" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gio::Seekable::can_seek </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Tests if the stream supports the SeekableIface. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>seekable</em> can be seeked. <code>false</code> otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="a961a029a8498e9223ed9c136cfe14597"></a><!-- doxytag: member="Gio::Seekable::can_truncate" ref="a961a029a8498e9223ed9c136cfe14597" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gio::Seekable::can_truncate </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Tests if the stream can be truncated. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the stream can be truncated, <code>false</code> otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="ac60caf803ddd50d08115da50ccb149dd"></a><!-- doxytag: member="Gio::Seekable::gobj" ref="ac60caf803ddd50d08115da50ccb149dd" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const GSeekable* Gio::Seekable::gobj </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C GObject. </p>

<p>Reimplemented from <a class="el" href="classGlib_1_1Interface.html#a70a443071a69d3372c2cdd7128a91ed1">Glib::Interface</a>.</p>

<p>Reimplemented in <a class="el" href="classGio_1_1FileInputStream.html#ab1afea7b758100ca02a6aa5b89d57662">Gio::FileInputStream</a>, <a class="el" href="classGio_1_1FileIOStream.html#acd384df600b1aea26bd10ca2e74f1b21">Gio::FileIOStream</a>, <a class="el" href="classGio_1_1FileOutputStream.html#a2bf847a5064b01e671731ecd56f88968">Gio::FileOutputStream</a>, <a class="el" href="classGio_1_1MemoryInputStream.html#af9ea44af840fc0d29d460498c8ce7d0e">Gio::MemoryInputStream</a>, and <a class="el" href="classGio_1_1MemoryOutputStream.html#a026181901b030a2f1f6e3b66026de5d3">Gio::MemoryOutputStream</a>.</p>

</div>
</div>
<a class="anchor" id="a96176a5c51102b9a2d02f4555f2e048f"></a><!-- doxytag: member="Gio::Seekable::gobj" ref="a96176a5c51102b9a2d02f4555f2e048f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GSeekable* Gio::Seekable::gobj </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C GObject. </p>

<p>Reimplemented from <a class="el" href="classGlib_1_1Interface.html#a969e9396f75132a9577428f4fa932d42">Glib::Interface</a>.</p>

<p>Reimplemented in <a class="el" href="classGio_1_1FileInputStream.html#a5411e06810e06ad339d7a21257772219">Gio::FileInputStream</a>, <a class="el" href="classGio_1_1FileIOStream.html#a382fe1830e5e347db4ae0d941398c0df">Gio::FileIOStream</a>, <a class="el" href="classGio_1_1FileOutputStream.html#aa69b1c94c5a3a2e0002fc6cf5127fc70">Gio::FileOutputStream</a>, <a class="el" href="classGio_1_1MemoryInputStream.html#a076380153e01599446bd991e0985db69">Gio::MemoryInputStream</a>, and <a class="el" href="classGio_1_1MemoryOutputStream.html#a3a52447ebfbc60722ced10d8aa625825">Gio::MemoryOutputStream</a>.</p>

</div>
</div>
<a class="anchor" id="a3404742af5d7855f6017578091f432cc"></a><!-- doxytag: member="Gio::Seekable::seek" ref="a3404742af5d7855f6017578091f432cc" args="(goffset offset, Glib::SeekType type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gio::Seekable::seek </td>
          <td>(</td>
          <td class="paramtype">goffset&#160;</td>
          <td class="paramname"> <em>offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__glibmmEnums.html#gaa3767731311bdba4ef42dc99215e5cda">Glib::SeekType</a>&#160;</td>
          <td class="paramname"> <em>type</em></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Seeks in the stream by the given <em>offset</em>, modified by <em>type</em> . </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&#160;</td><td>A goffset. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>type</em>&#160;</td><td>A <a class="el" href="group__glibmmEnums.html#gaa3767731311bdba4ef42dc99215e5cda">Glib::SeekType</a>. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if successful. If an error has occurred, this function will return <code>false</code>. </dd></dl>

</div>
</div>
<a class="anchor" id="aa717d10e2322df67b488657add79c70b"></a><!-- doxytag: member="Gio::Seekable::seek" ref="aa717d10e2322df67b488657add79c70b" args="(goffset offset, Glib::SeekType type, const Glib::RefPtr&lt; Cancellable &gt; &amp;cancellable)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gio::Seekable::seek </td>
          <td>(</td>
          <td class="paramtype">goffset&#160;</td>
          <td class="paramname"> <em>offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__glibmmEnums.html#gaa3767731311bdba4ef42dc99215e5cda">Glib::SeekType</a>&#160;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Cancellable.html">Cancellable</a> &gt;&amp;&#160;</td>
          <td class="paramname"> <em>cancellable</em></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Seeks in the stream by the given <em>offset</em>, modified by <em>type</em>. </p>
<p>The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> will be thrown with CANCELLED. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&#160;</td><td>A goffset. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>type</em>&#160;</td><td>A SeekType. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>cancellable</em>&#160;</td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if successful. If an error has occurred, this function will return <code>false</code> and set <em>error</em> appropriately if present. </dd></dl>

</div>
</div>
<a class="anchor" id="a3f270a74f487712bb0a89d86a8313987"></a><!-- doxytag: member="Gio::Seekable::tell" ref="a3f270a74f487712bb0a89d86a8313987" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">goffset Gio::Seekable::tell </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Tells the current position within the stream. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The offset from the beginning of the buffer. </dd></dl>

</div>
</div>
<a class="anchor" id="a4458c08f1486ce89f8a7f9b49f10eb13"></a><!-- doxytag: member="Gio::Seekable::truncate" ref="a4458c08f1486ce89f8a7f9b49f10eb13" args="(goffset offset)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gio::Seekable::truncate </td>
          <td>(</td>
          <td class="paramtype">goffset&#160;</td>
          <td class="paramname"> <em>offset</em></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Truncates a stream with a given offset. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&#160;</td><td>A goffset. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if successful. If an error has occured, this function will return <code>false</code>. </dd></dl>

</div>
</div>
<a class="anchor" id="aaf0792e6281670ea411cd7c3ef981998"></a><!-- doxytag: member="Gio::Seekable::truncate" ref="aaf0792e6281670ea411cd7c3ef981998" args="(goffset offset, const Glib::RefPtr&lt; Cancellable &gt; &amp;cancellable)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gio::Seekable::truncate </td>
          <td>(</td>
          <td class="paramtype">goffset&#160;</td>
          <td class="paramname"> <em>offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Cancellable.html">Cancellable</a> &gt;&amp;&#160;</td>
          <td class="paramname"> <em>cancellable</em></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Truncates a stream with a given offset. </p>
<p>The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a <a class="el" href="classGio_1_1Error.html" title="Exception class for giomm errors.">Gio::Error</a> will be thrown with CANCELLED. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&#160;</td><td>A goffset. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>cancellable</em>&#160;</td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if successful. If an error has occurred, this function will return <code>false</code> and set <em>error</em> appropriately if present. </dd></dl>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a0756ddeb91dc62f76d8a380716ecd228"></a><!-- doxytag: member="Gio::Seekable::wrap" ref="a0756ddeb91dc62f76d8a380716ecd228" args="(GSeekable *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Seekable.html">Gio::Seekable</a> &gt; wrap </td>
          <td>(</td>
          <td class="paramtype">GSeekable *&#160;</td>
          <td class="paramname"> <em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>object</em>&#160;</td><td>The C instance. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>take_copy</em>&#160;</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>giomm/seekable.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 11:07:24 2009 for glibmm by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>