1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
<title>FLAC::Metadata::SimpleIterator class Reference</title>
3
<title>FLAC: FLAC::Metadata::SimpleIterator Class Reference</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
<!-- Generated by Doxygen 1.2.14 -->
8
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
9
<hr><h1>FLAC::Metadata::SimpleIterator Class Reference<br>
6
<!-- Generated by Doxygen 1.4.2 -->
7
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
9
<b>FLAC</b>::<b>Metadata</b>::<a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html">SimpleIterator</a></div>
10
<h1>FLAC::Metadata::SimpleIterator Class Reference<br>
11
12
[<a class="el" href="group__flacpp__metadata__level1.html">FLAC++/metadata.h: metadata level 1 interface</a>]</small>
12
13
</h1><code>#include <<a class="el" href="+_2metadata_8h-source.html">metadata.h</a>></code>
14
<a href="classFLAC_1_1Metadata_1_1SimpleIterator-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
15
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
16
<tr><td nowrap align=right valign=top><a name="a0" doxytag="FLAC::Metadata::SimpleIterator::SimpleIterator"></a>
17
</td><td valign=bottom><b>SimpleIterator</b> ()</td></tr>
18
<tr><td nowrap align=right valign=top><a name="a1" doxytag="FLAC::Metadata::SimpleIterator::~SimpleIterator"></a>
19
virtual </td><td valign=bottom><b>~SimpleIterator</b> ()</td></tr>
20
<tr><td nowrap align=right valign=top><a name="a2" doxytag="FLAC::Metadata::SimpleIterator::init"></a>
21
bool </td><td valign=bottom><b>init</b> (const char *filename, bool read_only, bool preserve_file_stats)</td></tr>
22
<tr><td nowrap align=right valign=top><a name="a3" doxytag="FLAC::Metadata::SimpleIterator::is_valid"></a>
23
bool </td><td valign=bottom><b>is_valid</b> () const</td></tr>
24
<tr><td nowrap align=right valign=top><a name="a4" doxytag="FLAC::Metadata::SimpleIterator::status"></a>
25
Status </td><td valign=bottom><b>status</b> ()</td></tr>
26
<tr><td nowrap align=right valign=top><a name="a5" doxytag="FLAC::Metadata::SimpleIterator::is_writable"></a>
27
bool </td><td valign=bottom><b>is_writable</b> () const</td></tr>
28
<tr><td nowrap align=right valign=top><a name="a6" doxytag="FLAC::Metadata::SimpleIterator::next"></a>
29
bool </td><td valign=bottom><b>next</b> ()</td></tr>
30
<tr><td nowrap align=right valign=top><a name="a7" doxytag="FLAC::Metadata::SimpleIterator::prev"></a>
31
bool </td><td valign=bottom><b>prev</b> ()</td></tr>
32
<tr><td nowrap align=right valign=top><a name="a8" doxytag="FLAC::Metadata::SimpleIterator::get_block_type"></a>
33
::<a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> </td><td valign=bottom><b>get_block_type</b> () const</td></tr>
34
<tr><td nowrap align=right valign=top><a name="a9" doxytag="FLAC::Metadata::SimpleIterator::get_block"></a>
35
<a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> * </td><td valign=bottom><b>get_block</b> ()</td></tr>
36
<tr><td nowrap align=right valign=top><a name="a10" doxytag="FLAC::Metadata::SimpleIterator::set_block"></a>
37
bool </td><td valign=bottom><b>set_block</b> (<a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> *block, bool use_padding=true)</td></tr>
38
<tr><td nowrap align=right valign=top><a name="a11" doxytag="FLAC::Metadata::SimpleIterator::insert_block_after"></a>
39
bool </td><td valign=bottom><b>insert_block_after</b> (<a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> *block, bool use_padding=true)</td></tr>
40
<tr><td nowrap align=right valign=top><a name="a12" doxytag="FLAC::Metadata::SimpleIterator::delete_block"></a>
41
bool </td><td valign=bottom><b>delete_block</b> (bool use_padding=true)</td></tr>
42
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
43
<tr><td nowrap align=right valign=top><a name="b0" doxytag="FLAC::Metadata::SimpleIterator::clear"></a>
44
void </td><td valign=bottom><b>clear</b> ()</td></tr>
45
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
46
<tr><td nowrap align=right valign=top><a name="n0" doxytag="FLAC::Metadata::SimpleIterator::iterator_"></a>
47
::<a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> * </td><td valign=bottom><b>iterator_</b></td></tr>
49
<hr><a name="_details"></a><h2>Detailed Description</h2>
50
This class is a wrapper around the FLAC__metadata_simple_iterator structures and methods; see <a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a>.
15
<a href="classFLAC_1_1Metadata_1_1SimpleIterator-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
16
This class is a wrapper around the FLAC__metadata_simple_iterator structures and methods; see the <a class="el" href="group__flacpp__metadata__level1.html">usage guide </a> and <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a>.
18
<table border="0" cellpadding="0" cellspacing="0">
20
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
21
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora2">is_valid</a> () const </td></tr>
23
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora3">init</a> (const char *filename, bool read_only, bool preserve_file_stats)</td></tr>
25
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora4">status</a> ()</td></tr>
27
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora5">is_writable</a> () const </td></tr>
29
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora6">next</a> ()</td></tr>
31
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora7">prev</a> ()</td></tr>
33
<tr><td class="memItemLeft" nowrap align="right" valign="top">::<a class="el" href="group__flac__format.html#ga109">FLAC__MetadataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora8">get_block_type</a> () const </td></tr>
35
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora9">get_block</a> ()</td></tr>
37
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora10">set_block</a> (<a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> *block, bool use_padding=true)</td></tr>
39
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora11">insert_block_after</a> (<a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> *block, bool use_padding=true)</td></tr>
41
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#FLAC_1_1Metadata_1_1SimpleIteratora12">delete_block</a> (bool use_padding=true)</td></tr>
43
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
44
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratorb0" doxytag="FLAC::Metadata::SimpleIterator::clear"></a>
45
void </td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
47
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
48
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratorp0" doxytag="FLAC::Metadata::SimpleIterator::iterator_"></a>
49
::<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> * </td><td class="memItemRight" valign="bottom"><b>iterator_</b></td></tr>
51
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
52
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator_1_1Status.html">Status</a></td></tr>
55
<hr><h2>Member Function Documentation</h2>
56
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora2" doxytag="FLAC::Metadata::SimpleIterator::is_valid"></a><p>
57
<table class="mdTable" cellpadding="2" cellspacing="0">
60
<table cellpadding="0" cellspacing="0" border="0">
62
<td class="md" nowrap valign="top">bool FLAC::Metadata::SimpleIterator::is_valid </td>
63
<td class="md" valign="top">( </td>
64
<td class="mdname1" valign="top" nowrap> </td>
65
<td class="md" valign="top"> ) </td>
66
<td class="md" nowrap> const</td>
72
<table cellspacing="5" cellpadding="0" border="0">
80
Returns <code>true</code> iff object was properly constructed.
85
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora3" doxytag="FLAC::Metadata::SimpleIterator::init"></a><p>
86
<table class="mdTable" cellpadding="2" cellspacing="0">
89
<table cellpadding="0" cellspacing="0" border="0">
91
<td class="md" nowrap valign="top">bool FLAC::Metadata::SimpleIterator::init </td>
92
<td class="md" valign="top">( </td>
93
<td class="md" nowrap valign="top">const char * </td>
94
<td class="mdname" nowrap> <em>filename</em>, </td>
97
<td class="md" nowrap align="right"></td>
99
<td class="md" nowrap>bool </td>
100
<td class="mdname" nowrap> <em>read_only</em>, </td>
103
<td class="md" nowrap align="right"></td>
105
<td class="md" nowrap>bool </td>
106
<td class="mdname" nowrap> <em>preserve_file_stats</em></td>
110
<td class="md">) </td>
111
<td class="md" colspan="2"></td>
117
<table cellspacing="5" cellpadding="0" border="0">
125
See <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a>.
130
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora4" doxytag="FLAC::Metadata::SimpleIterator::status"></a><p>
131
<table class="mdTable" cellpadding="2" cellspacing="0">
134
<table cellpadding="0" cellspacing="0" border="0">
136
<td class="md" nowrap valign="top"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator_1_1Status.html">Status</a> FLAC::Metadata::SimpleIterator::status </td>
137
<td class="md" valign="top">( </td>
138
<td class="mdname1" valign="top" nowrap> </td>
139
<td class="md" valign="top"> ) </td>
140
<td class="md" nowrap></td>
146
<table cellspacing="5" cellpadding="0" border="0">
154
See <a class="el" href="group__flac__metadata__level1.html#ga4">FLAC__metadata_simple_iterator_status()</a>.
159
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora5" doxytag="FLAC::Metadata::SimpleIterator::is_writable"></a><p>
160
<table class="mdTable" cellpadding="2" cellspacing="0">
163
<table cellpadding="0" cellspacing="0" border="0">
165
<td class="md" nowrap valign="top">bool FLAC::Metadata::SimpleIterator::is_writable </td>
166
<td class="md" valign="top">( </td>
167
<td class="mdname1" valign="top" nowrap> </td>
168
<td class="md" valign="top"> ) </td>
169
<td class="md" nowrap> const</td>
175
<table cellspacing="5" cellpadding="0" border="0">
183
See <a class="el" href="group__flac__metadata__level1.html#ga6">FLAC__metadata_simple_iterator_is_writable()</a>.
188
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora6" doxytag="FLAC::Metadata::SimpleIterator::next"></a><p>
189
<table class="mdTable" cellpadding="2" cellspacing="0">
192
<table cellpadding="0" cellspacing="0" border="0">
194
<td class="md" nowrap valign="top">bool FLAC::Metadata::SimpleIterator::next </td>
195
<td class="md" valign="top">( </td>
196
<td class="mdname1" valign="top" nowrap> </td>
197
<td class="md" valign="top"> ) </td>
198
<td class="md" nowrap></td>
204
<table cellspacing="5" cellpadding="0" border="0">
212
See <a class="el" href="group__flac__metadata__level1.html#ga7">FLAC__metadata_simple_iterator_next()</a>.
217
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora7" doxytag="FLAC::Metadata::SimpleIterator::prev"></a><p>
218
<table class="mdTable" cellpadding="2" cellspacing="0">
221
<table cellpadding="0" cellspacing="0" border="0">
223
<td class="md" nowrap valign="top">bool FLAC::Metadata::SimpleIterator::prev </td>
224
<td class="md" valign="top">( </td>
225
<td class="mdname1" valign="top" nowrap> </td>
226
<td class="md" valign="top"> ) </td>
227
<td class="md" nowrap></td>
233
<table cellspacing="5" cellpadding="0" border="0">
241
See <a class="el" href="group__flac__metadata__level1.html#ga8">FLAC__metadata_simple_iterator_prev()</a>.
246
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora8" doxytag="FLAC::Metadata::SimpleIterator::get_block_type"></a><p>
247
<table class="mdTable" cellpadding="2" cellspacing="0">
250
<table cellpadding="0" cellspacing="0" border="0">
252
<td class="md" nowrap valign="top">::<a class="el" href="group__flac__format.html#ga109">FLAC__MetadataType</a> FLAC::Metadata::SimpleIterator::get_block_type </td>
253
<td class="md" valign="top">( </td>
254
<td class="mdname1" valign="top" nowrap> </td>
255
<td class="md" valign="top"> ) </td>
256
<td class="md" nowrap> const</td>
262
<table cellspacing="5" cellpadding="0" border="0">
270
See <a class="el" href="group__flac__metadata__level1.html#ga9">FLAC__metadata_simple_iterator_get_block_type()</a>.
275
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora9" doxytag="FLAC::Metadata::SimpleIterator::get_block"></a><p>
276
<table class="mdTable" cellpadding="2" cellspacing="0">
279
<table cellpadding="0" cellspacing="0" border="0">
281
<td class="md" nowrap valign="top"><a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a>* FLAC::Metadata::SimpleIterator::get_block </td>
282
<td class="md" valign="top">( </td>
283
<td class="mdname1" valign="top" nowrap> </td>
284
<td class="md" valign="top"> ) </td>
285
<td class="md" nowrap></td>
291
<table cellspacing="5" cellpadding="0" border="0">
299
See <a class="el" href="group__flac__metadata__level1.html#ga10">FLAC__metadata_simple_iterator_get_block()</a>.
304
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora10" doxytag="FLAC::Metadata::SimpleIterator::set_block"></a><p>
305
<table class="mdTable" cellpadding="2" cellspacing="0">
308
<table cellpadding="0" cellspacing="0" border="0">
310
<td class="md" nowrap valign="top">bool FLAC::Metadata::SimpleIterator::set_block </td>
311
<td class="md" valign="top">( </td>
312
<td class="md" nowrap valign="top"><a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> * </td>
313
<td class="mdname" nowrap> <em>block</em>, </td>
316
<td class="md" nowrap align="right"></td>
318
<td class="md" nowrap>bool </td>
319
<td class="mdname" nowrap> <em>use_padding</em> = <code>true</code></td>
323
<td class="md">) </td>
324
<td class="md" colspan="2"></td>
330
<table cellspacing="5" cellpadding="0" border="0">
338
See <a class="el" href="group__flac__metadata__level1.html#ga11">FLAC__metadata_simple_iterator_set_block()</a>.
343
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora11" doxytag="FLAC::Metadata::SimpleIterator::insert_block_after"></a><p>
344
<table class="mdTable" cellpadding="2" cellspacing="0">
347
<table cellpadding="0" cellspacing="0" border="0">
349
<td class="md" nowrap valign="top">bool FLAC::Metadata::SimpleIterator::insert_block_after </td>
350
<td class="md" valign="top">( </td>
351
<td class="md" nowrap valign="top"><a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> * </td>
352
<td class="mdname" nowrap> <em>block</em>, </td>
355
<td class="md" nowrap align="right"></td>
357
<td class="md" nowrap>bool </td>
358
<td class="mdname" nowrap> <em>use_padding</em> = <code>true</code></td>
362
<td class="md">) </td>
363
<td class="md" colspan="2"></td>
369
<table cellspacing="5" cellpadding="0" border="0">
377
See <a class="el" href="group__flac__metadata__level1.html#ga12">FLAC__metadata_simple_iterator_insert_block_after()</a>.
382
<a class="anchor" name="FLAC_1_1Metadata_1_1SimpleIteratora12" doxytag="FLAC::Metadata::SimpleIterator::delete_block"></a><p>
383
<table class="mdTable" cellpadding="2" cellspacing="0">
386
<table cellpadding="0" cellspacing="0" border="0">
388
<td class="md" nowrap valign="top">bool FLAC::Metadata::SimpleIterator::delete_block </td>
389
<td class="md" valign="top">( </td>
390
<td class="md" nowrap valign="top">bool </td>
391
<td class="mdname1" valign="top" nowrap> <em>use_padding</em> = <code>true</code> </td>
392
<td class="md" valign="top"> ) </td>
393
<td class="md" nowrap></td>
399
<table cellspacing="5" cellpadding="0" border="0">
407
See <a class="el" href="group__flac__metadata__level1.html#ga13">FLAC__metadata_simple_iterator_delete_block()</a>.
52
412
<hr>The documentation for this class was generated from the following file:<ul>
53
413
<li>include/FLAC++/<a class="el" href="+_2metadata_8h-source.html">metadata.h</a></ul>
54
<hr><address><small>Generated on Fri Feb 4 18:39:22 2005 for FLAC by
55
<a href="http://www.doxygen.org/index.html">
56
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
57
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
58
© 1997-2002</small></address>
416
<div class="copyright">
417
<!-- @@@ oh so hacky -->
421
Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson
423
<td width="1%" align="right">
424
<a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
429
<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson -->
430
<!-- Permission is granted to copy, distribute and/or modify this document -->
431
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
432
<!-- or any later version published by the Free Software Foundation; -->
433
<!-- with no invariant sections. -->
434
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->