<!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>id3lib: include/id3/id3lib_frame.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="id3lib.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">id3lib <span id="projectnumber">3.8.3</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>include/id3/id3lib_frame.h</h1> </div>
</div>
<div class="contents">
<a href="id3lib__frame_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- C++ -*-</span>
<a name="l00002"></a>00002 <span class="comment">// $Id: id3lib_frame.h,v 1.1 2002/08/10 10:55:47 t1mpy Exp $</span>
<a name="l00003"></a>00003
<a name="l00004"></a>00004 <span class="comment">// id3lib: a C++ library for creating and manipulating id3v1/v2 tags</span>
<a name="l00005"></a>00005 <span class="comment">// Copyright 1999, 2000 Scott Thomas Haug</span>
<a name="l00006"></a>00006
<a name="l00007"></a>00007 <span class="comment">// This library is free software; you can redistribute it and/or modify it</span>
<a name="l00008"></a>00008 <span class="comment">// under the terms of the GNU Library General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment">// the Free Software Foundation; either version 2 of the License, or (at your</span>
<a name="l00010"></a>00010 <span class="comment">// option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment">//</span>
<a name="l00012"></a>00012 <span class="comment">// This library is distributed in the hope that it will be useful, but WITHOUT</span>
<a name="l00013"></a>00013 <span class="comment">// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span>
<a name="l00014"></a>00014 <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">// License for more details.</span>
<a name="l00016"></a>00016 <span class="comment">//</span>
<a name="l00017"></a>00017 <span class="comment">// You should have received a copy of the GNU Library General Public License</span>
<a name="l00018"></a>00018 <span class="comment">// along with this library; if not, write to the Free Software Foundation,</span>
<a name="l00019"></a>00019 <span class="comment">// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="comment">// The id3lib authors encourage improvements and optimisations to be sent to</span>
<a name="l00022"></a>00022 <span class="comment">// the id3lib coordinator. Please see the README file for details on where to</span>
<a name="l00023"></a>00023 <span class="comment">// send such submissions. See the AUTHORS file for a list of people who have</span>
<a name="l00024"></a>00024 <span class="comment">// contributed to id3lib. See the ChangeLog file for a list of changes to</span>
<a name="l00025"></a>00025 <span class="comment">// id3lib. These files are distributed with id3lib at</span>
<a name="l00026"></a>00026 <span class="comment">// http://download.sourceforge.net/id3lib/</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef _ID3LIB_FRAME_H_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _ID3LIB_FRAME_H_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "id3/globals.h"</span> <span class="comment">//has <stdlib.h> "id3/sized_types.h"</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>;
<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a>;
<a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="class_i_d3___reader.html">ID3_Reader</a>;
<a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="class_i_d3___writer.html">ID3_Writer</a>;
<a name="l00037"></a>00037
<a name="l00038"></a><a class="code" href="class_i_d3___frame.html">00038</a> <span class="keyword">class </span><a class="code" href="globals_8h.html#aa7668e1ebc5c8b89aef71dd98e547f77">ID3_CPP_EXPORT</a> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <a class="code" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a>* _impl;
<a name="l00041"></a>00041 <span class="keyword">public</span>:
<a name="l00042"></a>00042
<a name="l00043"></a><a class="code" href="class_i_d3___frame_1_1_iterator.html">00043</a> <span class="keyword">class </span><a class="code" href="class_i_d3___frame_1_1_iterator.html">Iterator</a>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00046"></a>00046 <span class="keyword">virtual</span> <a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>* GetNext() = 0;
<a name="l00047"></a>00047 };
<a name="l00048"></a>00048
<a name="l00049"></a><a class="code" href="class_i_d3___frame_1_1_const_iterator.html">00049</a> <span class="keyword">class </span><a class="code" href="class_i_d3___frame_1_1_const_iterator.html">ConstIterator</a>
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 <span class="keyword">public</span>:
<a name="l00052"></a>00052 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>* GetNext() = 0;
<a name="l00053"></a>00053 };
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="keyword">public</span>:
<a name="l00056"></a>00056 <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> <span class="keywordtype">id</span> = <a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8aac969f7fe3c50b9d87efdf0ad15c3802c" title="No known frame.">ID3FID_NOFRAME</a>);
<a name="l00057"></a>00057 <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>(<span class="keyword">const</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>&);
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keyword">virtual</span> ~<a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>();
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keywordtype">void</span> Clear();
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keywordtype">bool</span> SetID(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> <span class="keywordtype">id</span>);
<a name="l00064"></a>00064 <a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> GetID() <span class="keyword">const</span>;
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>* GetField(<a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c" title="Enumeration of the different types of fields in a frame.">ID3_FieldID</a> name) <span class="keyword">const</span>;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keywordtype">size_t</span> NumFields() <span class="keyword">const</span>;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keyword">const</span> <span class="keywordtype">char</span>* GetDescription() <span class="keyword">const</span>;
<a name="l00071"></a>00071 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetDescription(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>);
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keyword">const</span> <span class="keywordtype">char</span>* GetTextID() <span class="keyword">const</span>;
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>& operator=(<span class="keyword">const</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a> &);
<a name="l00076"></a>00076 <span class="keywordtype">bool</span> HasChanged() <span class="keyword">const</span>;
<a name="l00077"></a>00077 <span class="keywordtype">bool</span> Parse(<a class="code" href="class_i_d3___reader.html">ID3_Reader</a>&);
<a name="l00078"></a>00078 <span class="keywordtype">void</span> Render(<a class="code" href="class_i_d3___writer.html">ID3_Writer</a>&) <span class="keyword">const</span>;
<a name="l00079"></a>00079 <span class="keywordtype">size_t</span> Size();
<a name="l00080"></a>00080 <span class="keywordtype">bool</span> Contains(<a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c" title="Enumeration of the different types of fields in a frame.">ID3_FieldID</a> fld) <span class="keyword">const</span>;
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> SetSpec(<a class="code" href="globals_8h.html#a48b13eb6cb3c520195901516dee1e612">ID3_V2Spec</a>);
<a name="l00082"></a>00082 <a class="code" href="globals_8h.html#a48b13eb6cb3c520195901516dee1e612">ID3_V2Spec</a> GetSpec() <span class="keyword">const</span>;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keywordtype">bool</span> SetCompression(<span class="keywordtype">bool</span> b);
<a name="l00085"></a>00085 <span class="keywordtype">bool</span> GetCompression() <span class="keyword">const</span>;
<a name="l00086"></a>00086 <span class="keywordtype">size_t</span> GetDataSize() <span class="keyword">const</span>;
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keywordtype">bool</span> SetEncryptionID(<a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> <span class="keywordtype">id</span>);
<a name="l00089"></a>00089 <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> GetEncryptionID() <span class="keyword">const</span>;
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keywordtype">bool</span> SetGroupingID(<a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> <span class="keywordtype">id</span>);
<a name="l00092"></a>00092 <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> GetGroupingID() <span class="keyword">const</span>;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <a class="code" href="class_i_d3___frame_1_1_iterator.html">Iterator</a>* CreateIterator();
<a name="l00095"></a>00095 <a class="code" href="class_i_d3___frame_1_1_const_iterator.html">ConstIterator</a>* CreateIterator() <span class="keyword">const</span>;
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment">// Deprecated</span>
<a name="l00098"></a>00098 <a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>& Field(<a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c" title="Enumeration of the different types of fields in a frame.">ID3_FieldID</a> name) <span class="keyword">const</span>;
<a name="l00099"></a>00099 <span class="comment">//ID3_Field* GetFieldNum(size_t) const;</span>
<a name="l00100"></a>00100 };
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="preprocessor">#endif </span><span class="comment">/* _ID3LIB_FRAME_H_ */</span>
<a name="l00103"></a>00103
</pre></div></div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated for id3lib by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.7.3</small></address></body></html>
