← Back to branch summary

~ubuntu-branches/ubuntu/trusty/glibmm2.4/trusty

« back to all changes in this revision

Viewing changes to docs/reference/html/classGio_1_1Seekable.html

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2012-06-18 12:13:18 UTC
  • mfrom: (1.2.73)
  • Revision ID: package-import@ubuntu.com-20120618121318-88t4ppyo8lq7s4ph
Tags: 2.33.1-0ubuntu1
* New upstream release
* debian/control:
  - Bump build-depends on libglib2.0-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/classGio_1_1Seekable.html
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
 
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
5
<title>glibmm: Gio::Seekable Class Reference</title>
7
6
 
8
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
23
22
  
24
23
  <td style="padding-left: 0.5em;">
25
24
   <div id="projectname">glibmm
26
 
   &#160;<span id="projectnumber">2.32.0</span>
 
25
   &#160;<span id="projectnumber">2.33.1</span>
27
26
   </div>
28
27
   
29
28
  </td>
35
34
</table>
36
35
</div>
37
36
 
38
 
<!-- Generated by Doxygen 1.7.6.1 -->
 
37
<!-- Generated by Doxygen 1.7.5 -->
39
38
  <div id="navrow1" class="tabs">
40
39
    <ul class="tablist">
41
40
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
69
68
<a href="#related">Related Functions</a> </div>
70
69
  <div class="headertitle">
71
70
<div class="title">Gio::Seekable Class Reference<div class="ingroups"><a class="el" href="group__Streams.html">Stream Classes</a></div></div> </div>
72
 
</div><!--header-->
 
71
</div>
73
72
<div class="contents">
74
73
<!-- doxytag: class="Gio::Seekable" --><!-- doxytag: inherits="Glib::Interface" -->
75
74
<p>Stream seeking interface.  <a href="classGio_1_1Seekable.html#details">More...</a></p>
96
95
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells the current position within the stream. <a href="#a3f270a74f487712bb0a89d86a8313987"></a><br/></td></tr>
97
96
<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>
98
97
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests if the stream supports the SeekableIface. <a href="#a5dd0a134172ea72595a9c7b2072e0350"></a><br/></td></tr>
99
 
<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> <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01612.html#ga2c2933c16c723af4d77eb939438617ca">type</a>, 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>
 
98
<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> <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01644.html#ga2c2933c16c723af4d77eb939438617ca">type</a>, 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>
100
99
<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>
101
 
<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> <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01612.html#ga2c2933c16c723af4d77eb939438617ca">type</a>)</td></tr>
 
100
<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> <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01644.html#ga2c2933c16c723af4d77eb939438617ca">type</a>)</td></tr>
102
101
<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>
103
102
<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>
104
103
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests if the stream can be truncated. <a href="#a961a029a8498e9223ed9c136cfe14597"></a><br/></td></tr>
130
129
<div class="memproto">
131
130
      <table class="memname">
132
131
        <tr>
133
 
          <td class="memname"><a class="el" href="classGio_1_1Seekable.html#a9601b59f26a240348bd70ec68b1c4f1f">Gio::Seekable::Seekable</a> </td>
 
132
          <td class="memname">Gio::Seekable::Seekable </td>
134
133
          <td>(</td>
135
134
          <td class="paramname"></td><td>)</td>
136
135
          <td><code> [protected]</code></td>
148
147
<div class="memproto">
149
148
      <table class="memname">
150
149
        <tr>
151
 
          <td class="memname">virtual <a class="el" href="classGio_1_1Seekable.html#a9b3fcb7df7b3e63b737e5bc5c7e74271">Gio::Seekable::~Seekable</a> </td>
 
150
          <td class="memname">virtual Gio::Seekable::~Seekable </td>
152
151
          <td>(</td>
153
152
          <td class="paramname"></td><td>)</td>
154
153
          <td><code> [virtual]</code></td>
165
164
<div class="memproto">
166
165
      <table class="memname">
167
166
        <tr>
168
 
          <td class="memname">static void <a class="el" href="classGio_1_1Seekable.html#ae8a94d31313527ff431cf49ba5af2bd8">Gio::Seekable::add_interface</a> </td>
 
167
          <td class="memname">static void Gio::Seekable::add_interface </td>
169
168
          <td>(</td>
170
169
          <td class="paramtype">GType&#160;</td>
171
170
          <td class="paramname"><em>gtype_implementer</em></td><td>)</td>
182
181
<div class="memproto">
183
182
      <table class="memname">
184
183
        <tr>
185
 
          <td class="memname">bool <a class="el" href="classGio_1_1Seekable.html#a5dd0a134172ea72595a9c7b2072e0350">Gio::Seekable::can_seek</a> </td>
 
184
          <td class="memname">bool Gio::Seekable::can_seek </td>
186
185
          <td>(</td>
187
186
          <td class="paramname"></td><td>)</td>
188
187
          <td> const</td>
201
200
<div class="memproto">
202
201
      <table class="memname">
203
202
        <tr>
204
 
          <td class="memname">bool <a class="el" href="classGio_1_1Seekable.html#a961a029a8498e9223ed9c136cfe14597">Gio::Seekable::can_truncate</a> </td>
 
203
          <td class="memname">bool Gio::Seekable::can_truncate </td>
205
204
          <td>(</td>
206
205
          <td class="paramname"></td><td>)</td>
207
206
          <td> const</td>
220
219
<div class="memproto">
221
220
      <table class="memname">
222
221
        <tr>
223
 
          <td class="memname">GSeekable* <a class="el" href="classGio_1_1Seekable.html#a96176a5c51102b9a2d02f4555f2e048f">Gio::Seekable::gobj</a> </td>
 
222
          <td class="memname">GSeekable* Gio::Seekable::gobj </td>
224
223
          <td>(</td>
225
224
          <td class="paramname"></td><td>)</td>
226
225
          <td><code> [inline]</code></td>
242
241
<div class="memproto">
243
242
      <table class="memname">
244
243
        <tr>
245
 
          <td class="memname">const GSeekable* <a class="el" href="classGio_1_1Seekable.html#a96176a5c51102b9a2d02f4555f2e048f">Gio::Seekable::gobj</a> </td>
 
244
          <td class="memname">const GSeekable* Gio::Seekable::gobj </td>
246
245
          <td>(</td>
247
246
          <td class="paramname"></td><td>)</td>
248
247
          <td> const<code> [inline]</code></td>
264
263
<div class="memproto">
265
264
      <table class="memname">
266
265
        <tr>
267
 
          <td class="memname">bool <a class="el" href="classGio_1_1Seekable.html#aa717d10e2322df67b488657add79c70b">Gio::Seekable::seek</a> </td>
 
266
          <td class="memname">bool Gio::Seekable::seek </td>
268
267
          <td>(</td>
269
268
          <td class="paramtype">goffset&#160;</td>
270
269
          <td class="paramname"><em>offset</em>, </td>
292
291
 
293
292
<p>Seeks in the stream by the given <em>offset</em>, modified by <em>type</em>. </p>
294
293
<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>
295
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
294
<dl><dt><b>Parameters:</b></dt><dd>
296
295
  <table class="params">
297
296
    <tr><td class="paramname">offset</td><td>A #goffset. </td></tr>
298
297
    <tr><td class="paramname">type</td><td>A SeekType. </td></tr>
309
308
<div class="memproto">
310
309
      <table class="memname">
311
310
        <tr>
312
 
          <td class="memname">bool <a class="el" href="classGio_1_1Seekable.html#aa717d10e2322df67b488657add79c70b">Gio::Seekable::seek</a> </td>
 
311
          <td class="memname">bool Gio::Seekable::seek </td>
313
312
          <td>(</td>
314
313
          <td class="paramtype">goffset&#160;</td>
315
314
          <td class="paramname"><em>offset</em>, </td>
330
329
<div class="memdoc">
331
330
 
332
331
<p>Seeks in the stream by the given <em>offset</em>, modified by <em>type</em> . </p>
333
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
332
<dl><dt><b>Parameters:</b></dt><dd>
334
333
  <table class="params">
335
334
    <tr><td class="paramname">offset</td><td>A #goffset. </td></tr>
336
335
    <tr><td class="paramname">type</td><td>A <a class="el" href="group__glibmmEnums.html#gaa3767731311bdba4ef42dc99215e5cda">Glib::SeekType</a>. </td></tr>
346
345
<div class="memproto">
347
346
      <table class="memname">
348
347
        <tr>
349
 
          <td class="memname">goffset <a class="el" href="classGio_1_1Seekable.html#a3f270a74f487712bb0a89d86a8313987">Gio::Seekable::tell</a> </td>
 
348
          <td class="memname">goffset Gio::Seekable::tell </td>
350
349
          <td>(</td>
351
350
          <td class="paramname"></td><td>)</td>
352
351
          <td> const</td>
365
364
<div class="memproto">
366
365
      <table class="memname">
367
366
        <tr>
368
 
          <td class="memname">bool <a class="el" href="classGio_1_1Seekable.html#aaf0792e6281670ea411cd7c3ef981998">Gio::Seekable::truncate</a> </td>
 
367
          <td class="memname">bool Gio::Seekable::truncate </td>
369
368
          <td>(</td>
370
369
          <td class="paramtype">goffset&#160;</td>
371
370
          <td class="paramname"><em>offset</em>, </td>
387
386
 
388
387
<p>Truncates a stream with a given #offset. </p>
389
388
<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>
390
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
389
<dl><dt><b>Parameters:</b></dt><dd>
391
390
  <table class="params">
392
391
    <tr><td class="paramname">offset</td><td>A #goffset. </td></tr>
393
392
    <tr><td class="paramname">cancellable</td><td><a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a> object. </td></tr>
403
402
<div class="memproto">
404
403
      <table class="memname">
405
404
        <tr>
406
 
          <td class="memname">bool <a class="el" href="classGio_1_1Seekable.html#aaf0792e6281670ea411cd7c3ef981998">Gio::Seekable::truncate</a> </td>
 
405
          <td class="memname">bool Gio::Seekable::truncate </td>
407
406
          <td>(</td>
408
407
          <td class="paramtype">goffset&#160;</td>
409
408
          <td class="paramname"><em>offset</em></td><td>)</td>
414
413
<div class="memdoc">
415
414
 
416
415
<p>Truncates a stream with a given #offset. </p>
417
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
416
<dl><dt><b>Parameters:</b></dt><dd>
418
417
  <table class="params">
419
418
    <tr><td class="paramname">offset</td><td>A #goffset. </td></tr>
420
419
  </table>
430
429
<div class="memproto">
431
430
      <table class="memname">
432
431
        <tr>
433
 
          <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; <a class="el" href="classGio_1_1Seekable.html#a0756ddeb91dc62f76d8a380716ecd228">wrap</a> </td>
 
432
          <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>
434
433
          <td>(</td>
435
434
          <td class="paramtype">GSeekable *&#160;</td>
436
435
          <td class="paramname"><em>object</em>, </td>
451
450
<div class="memdoc">
452
451
 
453
452
<p>A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
454
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
453
<dl><dt><b>Parameters:</b></dt><dd>
455
454
  <table class="params">
456
455
    <tr><td class="paramname">object</td><td>The C instance. </td></tr>
457
456
    <tr><td class="paramname">take_copy</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>
462
461
 
463
462
</div>
464
463
</div>
465
 
</div><!-- contents -->
 
464
</div>
466
465
 
467
466
 
468
467
<hr class="footer"/><address class="footer"><small>
469
 
Generated on Tue Apr 10 2012 14:20:38 for glibmm by &#160;<a href="http://www.doxygen.org/index.html">
 
468
Generated on Tue Jun 12 2012 09:21:30 for glibmm by &#160;<a href="http://www.doxygen.org/index.html">
470
469
<img class="footer" src="doxygen.png" alt="doxygen"/>
471
 
</a> 1.7.6.1
 
470
</a> 1.7.5
472
471
</small></address>
473
472
 
474
473
</body>