Sophie: libid3lib3.8_0-devel-3.8.0-0.pre2.1.1mdk i586

libid3lib3.8_0-devel-3.8.0-0.pre2.1.1mdk.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>include/id3/field.h Source File</title>
<link href="id3lib.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.12 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>include/id3/field.h</h1><a href="field_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">// -*- C++ -*-</font>
00002 <font class="comment">// $Id: field.h,v 1.44 2001/08/07 11:58:23 shadrack Exp $</font>
00003 
00004 <font class="comment">// id3lib: a C++ library for creating and manipulating id3v1/v2 tags</font>
00005 <font class="comment">// Copyright 1999, 2000  Scott Thomas Haug</font>
00006 
00007 <font class="comment">// This library is free software; you can redistribute it and/or modify it</font>
00008 <font class="comment">// under the terms of the GNU Library General Public License as published by</font>
00009 <font class="comment">// the Free Software Foundation; either version 2 of the License, or (at your</font>
00010 <font class="comment">// option) any later version.</font>
00011 <font class="comment">//</font>
00012 <font class="comment">// This library is distributed in the hope that it will be useful, but WITHOUT</font>
00013 <font class="comment">// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</font>
00014 <font class="comment">// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public</font>
00015 <font class="comment">// License for more details.</font>
00016 <font class="comment">//</font>
00017 <font class="comment">// You should have received a copy of the GNU Library General Public License</font>
00018 <font class="comment">// along with this library; if not, write to the Free Software Foundation,</font>
00019 <font class="comment">// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</font>
00020 
00021 <font class="comment">// The id3lib authors encourage improvements and optimisations to be sent to</font>
00022 <font class="comment">// the id3lib coordinator.  Please see the README file for details on where to</font>
00023 <font class="comment">// send such submissions.  See the AUTHORS file for a list of people who have</font>
00024 <font class="comment">// contributed to id3lib.  See the ChangeLog file for a list of changes to</font>
00025 <font class="comment">// id3lib.  These files are distributed with id3lib at</font>
00026 <font class="comment">// http://download.sourceforge.net/id3lib/</font>
00027 
00028 <font class="preprocessor">#ifndef _ID3LIB_FIELD_H_</font>
00029 <font class="preprocessor"></font><font class="preprocessor">#define _ID3LIB_FIELD_H_</font>
00030 <font class="preprocessor"></font>
00031 <font class="preprocessor">#include &lt;<a class="code" href="globals_8h.html">id3/globals.h</a>&gt;</font>
00032 
00033 <font class="keyword">class </font><a class="code" href="class_i_d3___reader.html">ID3_Reader</a>;
00034 <font class="keyword">class </font><a class="code" href="class_i_d3___writer.html">ID3_Writer</a>;
00035 
<a name="l00036"></a><a class="code" href="class_i_d3___field.html">00036</a> <font class="keyword">class </font><a class="code" href="globals_8h.html#a1">ID3_CPP_EXPORT</a> <a class="code" href="class_i_d3___field.html">ID3_Field</a>
00037 {
00038 <font class="keyword">public</font>:
00039   <font class="keyword">virtual</font> <font class="keywordtype">void</font> Clear() = 0;
00040 
00041   <font class="keyword">virtual</font> size_t Size() <font class="keyword">const</font> = 0;
00042   <font class="keyword">virtual</font> size_t BinSize() <font class="keyword">const</font> = 0;
00043   <font class="keyword">virtual</font> size_t GetNumTextItems() <font class="keyword">const</font> = 0;
00044 
00045   <font class="comment">// integer field functions</font>
00046   <font class="keyword">virtual</font> <a class="code" href="class_i_d3___field.html">ID3_Field</a>&amp;    operator= (<a class="code" href="sized__types_8h.html#a4">uint32</a> val) = 0;
00047   <font class="keyword">virtual</font> <font class="keywordtype">void</font>          Set(<a class="code" href="sized__types_8h.html#a4">uint32</a>) = 0;
00048   <font class="keyword">virtual</font> <a class="code" href="sized__types_8h.html#a4">uint32</a>        Get() <font class="keyword">const</font> = 0;
00049 
00050   <font class="comment">// ASCII string field functions</font>
00051   <font class="keyword">virtual</font> <a class="code" href="class_i_d3___field.html">ID3_Field</a>&amp;    operator= (<font class="keyword">const</font> <font class="keywordtype">char</font>* s) = 0;
00052   <font class="keyword">virtual</font> size_t        Set(<font class="keyword">const</font> <font class="keywordtype">char</font>*) = 0;
00053   <font class="keyword">virtual</font> size_t        Get(<font class="keywordtype">char</font>*, size_t) <font class="keyword">const</font> = 0;
00054   <font class="keyword">virtual</font> size_t        Get(<font class="keywordtype">char</font>*, size_t, <a class="code" href="globals_8h.html#a7">index_t</a>) <font class="keyword">const</font> = 0;
00055   <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font>*   GetRawText() <font class="keyword">const</font> = 0;
00056   <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font>*   GetRawTextItem(<a class="code" href="globals_8h.html#a7">index_t</a>) <font class="keyword">const</font> = 0;
00057   <font class="keyword">virtual</font> size_t        Add(<font class="keyword">const</font> <font class="keywordtype">char</font>*) = 0;
00058 
00059   <font class="comment">// Unicode string field functions</font>
00060   <font class="keyword">virtual</font> <a class="code" href="class_i_d3___field.html">ID3_Field</a>&amp;    operator= (<font class="keyword">const</font> <a class="code" href="globals_8h.html#a39">unicode_t</a>* s) = 0;
00061   <font class="keyword">virtual</font> size_t        Set(<font class="keyword">const</font> <a class="code" href="globals_8h.html#a39">unicode_t</a>*) = 0;
00062   <font class="keyword">virtual</font> size_t        Get(<a class="code" href="globals_8h.html#a39">unicode_t</a> *buffer, size_t) <font class="keyword">const</font> = 0;
00063   <font class="keyword">virtual</font> size_t        Get(<a class="code" href="globals_8h.html#a39">unicode_t</a> *buffer, size_t, <a class="code" href="globals_8h.html#a7">index_t</a>) <font class="keyword">const</font> = 0;
00064   <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="globals_8h.html#a39">unicode_t</a>* GetRawUnicodeText() <font class="keyword">const</font> = 0;
00065   <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="globals_8h.html#a39">unicode_t</a>* GetRawUnicodeTextItem(<a class="code" href="globals_8h.html#a7">index_t</a>) <font class="keyword">const</font> = 0;
00066   <font class="keyword">virtual</font> size_t        Add(<font class="keyword">const</font> <a class="code" href="globals_8h.html#a39">unicode_t</a>*) = 0;
00067 
00068   <font class="comment">// binary field functions</font>
00069   <font class="keyword">virtual</font> size_t        Set(<font class="keyword">const</font> <a class="code" href="globals_8h.html#a33">uchar</a>*, size_t) = 0;
00070   <font class="keyword">virtual</font> size_t        Get(<a class="code" href="globals_8h.html#a33">uchar</a>*, size_t) <font class="keyword">const</font> = 0;
00071   <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="globals_8h.html#a33">uchar</a>*  GetRawBinary() <font class="keyword">const</font> = 0;
00072   <font class="keyword">virtual</font> <font class="keywordtype">void</font>          FromFile(<font class="keyword">const</font> <font class="keywordtype">char</font>*) = 0;
00073   <font class="keyword">virtual</font> <font class="keywordtype">void</font>          ToFile(<font class="keyword">const</font> <font class="keywordtype">char</font> *sInfo) <font class="keyword">const</font> = 0;
00074   
00075   <font class="comment">// miscelaneous functions</font>
00076   <font class="keyword">virtual</font> <a class="code" href="class_i_d3___field.html">ID3_Field</a>&amp;    operator=( <font class="keyword">const</font> <a class="code" href="class_i_d3___field.html">ID3_Field</a> &amp; ) = 0;
00077   <font class="keyword">virtual</font> <font class="keywordtype">bool</font>          InScope(<a class="code" href="globals_8h.html#a216">ID3_V2Spec</a> spec) <font class="keyword">const</font> = 0;
00078 
00079   <font class="keyword">virtual</font> <a class="code" href="globals_8h.html#a218">ID3_FieldID</a>   GetID() <font class="keyword">const</font> = 0;
00080   <font class="keyword">virtual</font> <a class="code" href="globals_8h.html#a222">ID3_FieldType</a> GetType() <font class="keyword">const</font> = 0;
00081   <font class="keyword">virtual</font> <font class="keywordtype">bool</font>          SetEncoding(<a class="code" href="globals_8h.html#a214">ID3_TextEnc</a> enc) = 0;
00082   <font class="keyword">virtual</font> <a class="code" href="globals_8h.html#a214">ID3_TextEnc</a>   GetEncoding() <font class="keyword">const</font> = 0;
00083   <font class="keyword">virtual</font> <font class="keywordtype">bool</font>          IsEncodable() <font class="keyword">const</font> = 0;
00084 
00085   <font class="keyword">virtual</font> <font class="keywordtype">void</font>          Render(<a class="code" href="class_i_d3___writer.html">ID3_Writer</a>&amp;) <font class="keyword">const</font> = 0;
00086   <font class="keyword">virtual</font> <font class="keywordtype">bool</font>          Parse(<a class="code" href="class_i_d3___reader.html">ID3_Reader</a>&amp;) = 0;
00087   <font class="keyword">virtual</font> <font class="keywordtype">bool</font>          HasChanged() <font class="keyword">const</font> = 0;
00088 
00089 <font class="keyword">protected</font>:
<a name="l00090"></a><a class="code" href="class_i_d3___field.html#b0">00090</a>   <font class="keyword">virtual</font> ~<a class="code" href="class_i_d3___field.html">ID3_Field</a>() { };
00091 
00092   <font class="comment">// To prevent public instantiation, the constructor is made protected</font>
<a name="l00093"></a><a class="code" href="class_i_d3___field.html#b1">00093</a>   <a class="code" href="class_i_d3___field.html">ID3_Field</a>() { };
00094 };
00095 
<a name="l00096"></a><a class="code" href="class_i_d3___frame_info.html">00096</a> <font class="keyword">class </font><a class="code" href="globals_8h.html#a1">ID3_CPP_EXPORT</a> ID3_FrameInfo
00097 {
00098 
00099 <font class="keyword">public</font>:
<a name="l00100"></a><a class="code" href="class_i_d3___frame_info.html#a0">00100</a>   ID3_FrameInfo() {};
<a name="l00101"></a><a class="code" href="class_i_d3___frame_info.html#a1">00101</a>   ~ID3_FrameInfo() {};
00102   <font class="keywordtype">char</font> *ShortName(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> frameid);
00103   <font class="keywordtype">char</font> *LongName(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> frameid);
00104   <font class="keyword">const</font> <font class="keywordtype">char</font> *Description(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> frameid);
00105   <font class="keywordtype">int</font> MaxFrameID();
00106   <font class="keywordtype">int</font> NumFields(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> frameid);
00107   <a class="code" href="globals_8h.html#a222">ID3_FieldType</a> FieldType(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> frameid, <font class="keywordtype">int</font> fieldnum);
00108   size_t FieldSize(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> frameid, <font class="keywordtype">int</font> fieldnum);
00109   <a class="code" href="globals_8h.html#a40">flags_t</a> FieldFlags(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a> frameid, <font class="keywordtype">int</font> fieldnum);
00110 };
00111 
00112 <font class="preprocessor">#endif </font><font class="comment">/* _ID3LIB_FIELD_H_ */</font>
</pre></div><hr><address><small>Generated on Thu Jan 3 07:35:55 2002 for id3lib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.12 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>