<!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/field.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.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<h1>include/id3/field.h</h1><a href="field_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: field.h,v 1.47 2002/07/02 22:10:26 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_FIELD_H_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _ID3LIB_FIELD_H_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="globals_8h.html">id3/globals.h</a>"</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___reader.html">ID3_Reader</a>;
<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="class_i_d3___writer.html">ID3_Writer</a>;
<a name="l00035"></a>00035
<a name="l00036"></a><a class="code" href="class_i_d3___field.html">00036</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___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">public</span>:
<a name="l00039"></a>00039 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Clear() = 0;
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Size() <span class="keyword">const</span> = 0;
<a name="l00042"></a>00042 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> BinSize() <span class="keyword">const</span> = 0;
<a name="l00043"></a>00043 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetNumTextItems() <span class="keyword">const</span> = 0;
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="comment">// integer field functions</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>& operator= (uint32 val) = 0;
<a name="l00047"></a>00047 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Set(uint32) = 0;
<a name="l00048"></a>00048 <span class="keyword">virtual</span> uint32 Get() <span class="keyword">const</span> = 0;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="comment">// ASCII string field functions</span>
<a name="l00051"></a>00051 <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>& operator= (<span class="keyword">const</span> <span class="keywordtype">char</span>* s) = 0;
<a name="l00052"></a>00052 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Set(<span class="keyword">const</span> <span class="keywordtype">char</span>*) = 0;
<a name="l00053"></a>00053 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Get(<span class="keywordtype">char</span>*, <span class="keywordtype">size_t</span>) <span class="keyword">const</span> = 0;
<a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Get(<span class="keywordtype">char</span>*, <span class="keywordtype">size_t</span>, <span class="keywordtype">size_t</span>) <span class="keyword">const</span> = 0;
<a name="l00055"></a>00055 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetRawText() <span class="keyword">const</span> = 0;
<a name="l00056"></a>00056 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetRawTextItem(<span class="keywordtype">size_t</span>) <span class="keyword">const</span> = 0;
<a name="l00057"></a>00057 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Add(<span class="keyword">const</span> <span class="keywordtype">char</span>*) = 0;
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">// Unicode string field functions</span>
<a name="l00060"></a>00060 <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>& operator= (<span class="keyword">const</span> <a class="code" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a>* s) = 0;
<a name="l00061"></a>00061 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Set(<span class="keyword">const</span> <a class="code" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a>*) = 0;
<a name="l00062"></a>00062 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Get(<a class="code" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> *buffer, <span class="keywordtype">size_t</span>) <span class="keyword">const</span> = 0;
<a name="l00063"></a>00063 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Get(<a class="code" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> *buffer, <span class="keywordtype">size_t</span>, <span class="keywordtype">size_t</span>) <span class="keyword">const</span> = 0;
<a name="l00064"></a>00064 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a>* GetRawUnicodeText() <span class="keyword">const</span> = 0;
<a name="l00065"></a>00065 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a>* GetRawUnicodeTextItem(<span class="keywordtype">size_t</span>) <span class="keyword">const</span> = 0;
<a name="l00066"></a>00066 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Add(<span class="keyword">const</span> <a class="code" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a>*) = 0;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="comment">// binary field functions</span>
<a name="l00069"></a>00069 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Set(<span class="keyword">const</span> <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a>*, <span class="keywordtype">size_t</span>) = 0;
<a name="l00070"></a>00070 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Get(<a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a>*, <span class="keywordtype">size_t</span>) <span class="keyword">const</span> = 0;
<a name="l00071"></a>00071 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a>* GetRawBinary() <span class="keyword">const</span> = 0;
<a name="l00072"></a>00072 <span class="keyword">virtual</span> <span class="keywordtype">void</span> FromFile(<span class="keyword">const</span> <span class="keywordtype">char</span>*) = 0;
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ToFile(<span class="keyword">const</span> <span class="keywordtype">char</span> *sInfo) <span class="keyword">const</span> = 0;
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// miscelaneous functions</span>
<a name="l00076"></a>00076 <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>& operator=( <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> & ) = 0;
<a name="l00077"></a>00077 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> InScope(<a class="code" href="globals_8h.html#a48b13eb6cb3c520195901516dee1e612">ID3_V2Spec</a> spec) <span class="keyword">const</span> = 0;
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="keyword">virtual</span> <a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c" title="Enumeration of the different types of fields in a frame.">ID3_FieldID</a> GetID() <span class="keyword">const</span> = 0;
<a name="l00080"></a>00080 <span class="keyword">virtual</span> <a class="code" href="globals_8h.html#adc0ffe8cf70623e6d4d17092b20bdd6b" title="Enumeration of the types of field types.">ID3_FieldType</a> GetType() <span class="keyword">const</span> = 0;
<a name="l00081"></a>00081 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SetEncoding(<a class="code" href="globals_8h.html#a2a414b8e1666bd6dd8dce86cdcf74a39" title="Enumeration of the types of text encodings: ascii or unicode.">ID3_TextEnc</a> enc) = 0;
<a name="l00082"></a>00082 <span class="keyword">virtual</span> <a class="code" href="globals_8h.html#a2a414b8e1666bd6dd8dce86cdcf74a39" title="Enumeration of the types of text encodings: ascii or unicode.">ID3_TextEnc</a> GetEncoding() <span class="keyword">const</span> = 0;
<a name="l00083"></a>00083 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsEncodable() <span class="keyword">const</span> = 0;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Render(<a class="code" href="class_i_d3___writer.html">ID3_Writer</a>&) <span class="keyword">const</span> = 0;
<a name="l00086"></a>00086 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Parse(<a class="code" href="class_i_d3___reader.html">ID3_Reader</a>&) = 0;
<a name="l00087"></a>00087 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> HasChanged() <span class="keyword">const</span> = 0;
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">protected</span>:
<a name="l00090"></a><a class="code" href="class_i_d3___field.html#accd96a7466928e0aaef519c3ff3bf5df">00090</a> <span class="keyword">virtual</span> <a class="code" href="class_i_d3___field.html#accd96a7466928e0aaef519c3ff3bf5df">~ID3_Field</a>() { };
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="comment">// To prevent public instantiation, the constructor is made protected</span>
<a name="l00093"></a><a class="code" href="class_i_d3___field.html#a2b1bbb304814bef2c1b4e76fa27c6617">00093</a> <a class="code" href="class_i_d3___field.html#a2b1bbb304814bef2c1b4e76fa27c6617">ID3_Field</a>() { };
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095
<a name="l00096"></a><a class="code" href="class_i_d3___frame_info.html">00096</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_info.html" title="Provides information about the frame and field types supported by id3lib.">ID3_FrameInfo</a>
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">public</span>:
<a name="l00100"></a><a class="code" href="class_i_d3___frame_info.html#ae97a90793d3ce9f1e1d2a730692e364d">00100</a> <a class="code" href="class_i_d3___frame_info.html#ae97a90793d3ce9f1e1d2a730692e364d">ID3_FrameInfo</a>() {};
<a name="l00101"></a><a class="code" href="class_i_d3___frame_info.html#ae099786a1015b039827f0e470c14d992">00101</a> <a class="code" href="class_i_d3___frame_info.html#ae099786a1015b039827f0e470c14d992">~ID3_FrameInfo</a>() {};
<a name="l00102"></a>00102 <span class="keywordtype">char</span> *ShortName(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> frameid);
<a name="l00103"></a>00103 <span class="keywordtype">char</span> *LongName(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> frameid);
<a name="l00104"></a>00104 <span class="keyword">const</span> <span class="keywordtype">char</span> *Description(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> frameid);
<a name="l00105"></a>00105 <span class="keywordtype">int</span> MaxFrameID();
<a name="l00106"></a>00106 <span class="keywordtype">int</span> NumFields(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> frameid);
<a name="l00107"></a>00107 <a class="code" href="globals_8h.html#adc0ffe8cf70623e6d4d17092b20bdd6b" title="Enumeration of the types of field types.">ID3_FieldType</a> FieldType(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> frameid, <span class="keywordtype">int</span> fieldnum);
<a name="l00108"></a>00108 <span class="keywordtype">size_t</span> FieldSize(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> frameid, <span class="keywordtype">int</span> fieldnum);
<a name="l00109"></a>00109 <a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a> FieldFlags(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> frameid, <span class="keywordtype">int</span> fieldnum);
<a name="l00110"></a>00110 };
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="preprocessor">#endif </span><span class="comment">/* _ID3LIB_FIELD_H_ */</span>
<a name="l00113"></a>00113
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Jan 12 23:46:35 2011 for id3lib by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mageia
>
1
>
i586
>
media
>
core-release
>
by-pkgid
>
1b812d1b0e765bcc0430721ff58676d2
>
files
>
127
