<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>id3lib: ID3_Field Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="id3lib.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="class_i_d3___field-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ID3_Field Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The representative class of an ID3v2 field.
<a href="class_i_d3___field.html#details">More...</a></p>
<p><code>#include <<a class="el" href="field_8h_source.html">id3/field.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ID3_Field:</div>
<div class="dyncontent">
<div class="center">
<img src="class_i_d3___field.png" usemap="#ID3_Field_map" alt=""/>
<map id="ID3_Field_map" name="ID3_Field_map">
<area href="class_i_d3___field_impl.html" alt="ID3_FieldImpl" shape="rect" coords="0,56,88,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1de0019592f57cdc7a3215ce2122e671"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a1de0019592f57cdc7a3215ce2122e671">Clear</a> ()=0</td></tr>
<tr class="separator:a1de0019592f57cdc7a3215ce2122e671"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4eed557e9f540d3c9347ac31f0f8e55b"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a4eed557e9f540d3c9347ac31f0f8e55b">Size</a> () const =0</td></tr>
<tr class="memdesc:a4eed557e9f540d3c9347ac31f0f8e55b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of a field. <a href="#a4eed557e9f540d3c9347ac31f0f8e55b"></a><br/></td></tr>
<tr class="separator:a4eed557e9f540d3c9347ac31f0f8e55b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aefa9e7690d7097ec315b029e31eb1973"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#aefa9e7690d7097ec315b029e31eb1973">BinSize</a> () const =0</td></tr>
<tr class="separator:aefa9e7690d7097ec315b029e31eb1973"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d3c0e640a68fee3afc2498944027b86"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a9d3c0e640a68fee3afc2498944027b86">GetNumTextItems</a> () const =0</td></tr>
<tr class="separator:a9d3c0e640a68fee3afc2498944027b86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2431905ed199a8c541a970986d0735a7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___field.html">ID3_Field</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a2431905ed199a8c541a970986d0735a7">operator=</a> (uint32 val)=0</td></tr>
<tr class="memdesc:a2431905ed199a8c541a970986d0735a7"><td class="mdescLeft"> </td><td class="mdescRight">A shortcut for the Set method. <a href="#a2431905ed199a8c541a970986d0735a7"></a><br/></td></tr>
<tr class="separator:a2431905ed199a8c541a970986d0735a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16387cf6c54df5432a0c048d6a931f03"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a16387cf6c54df5432a0c048d6a931f03">Set</a> (uint32)=0</td></tr>
<tr class="separator:a16387cf6c54df5432a0c048d6a931f03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a363d1034fb4e60e85f15bcf9818d33ef"><td class="memItemLeft" align="right" valign="top">virtual uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a363d1034fb4e60e85f15bcf9818d33ef">Get</a> () const =0</td></tr>
<tr class="memdesc:a363d1034fb4e60e85f15bcf9818d33ef"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the integer field. <a href="#a363d1034fb4e60e85f15bcf9818d33ef"></a><br/></td></tr>
<tr class="separator:a363d1034fb4e60e85f15bcf9818d33ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1afc1275f1c9fdf8d46c8801c0160696"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___field.html">ID3_Field</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a1afc1275f1c9fdf8d46c8801c0160696">operator=</a> (const char *s)=0</td></tr>
<tr class="memdesc:a1afc1275f1c9fdf8d46c8801c0160696"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for the Set operator. <a href="#a1afc1275f1c9fdf8d46c8801c0160696"></a><br/></td></tr>
<tr class="separator:a1afc1275f1c9fdf8d46c8801c0160696"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55ea11a70916093009ebbd6628bf690e"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a55ea11a70916093009ebbd6628bf690e">Set</a> (const char *)=0</td></tr>
<tr class="separator:a55ea11a70916093009ebbd6628bf690e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad57d9cfe6175c1a53c483edbc2ac814f"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#ad57d9cfe6175c1a53c483edbc2ac814f">Get</a> (char *, size_t) const =0</td></tr>
<tr class="separator:ad57d9cfe6175c1a53c483edbc2ac814f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5c8fe7d909fdf52b5a6eb2538a39dc2"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#ad5c8fe7d909fdf52b5a6eb2538a39dc2">Get</a> (char *, size_t, size_t) const =0</td></tr>
<tr class="separator:ad5c8fe7d909fdf52b5a6eb2538a39dc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b306f45543afd5459e77200a0fc0a1f"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a1b306f45543afd5459e77200a0fc0a1f">GetRawText</a> () const =0</td></tr>
<tr class="separator:a1b306f45543afd5459e77200a0fc0a1f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae05e22d1918f2265d9fb0970ef5f09d"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#aae05e22d1918f2265d9fb0970ef5f09d">GetRawTextItem</a> (size_t) const =0</td></tr>
<tr class="separator:aae05e22d1918f2265d9fb0970ef5f09d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade699be00ad543bf60bafb7fc9c0122a"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#ade699be00ad543bf60bafb7fc9c0122a">Add</a> (const char *)=0</td></tr>
<tr class="separator:ade699be00ad543bf60bafb7fc9c0122a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab816bf9e67b17f911b9814fc154414d7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___field.html">ID3_Field</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#ab816bf9e67b17f911b9814fc154414d7">operator=</a> (const <a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> *s)=0</td></tr>
<tr class="memdesc:ab816bf9e67b17f911b9814fc154414d7"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for the Set operator. <a href="#ab816bf9e67b17f911b9814fc154414d7"></a><br/></td></tr>
<tr class="separator:ab816bf9e67b17f911b9814fc154414d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa16f88c3974eaf61af67369ef02d5c1"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#afa16f88c3974eaf61af67369ef02d5c1">Set</a> (const <a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> *)=0</td></tr>
<tr class="separator:afa16f88c3974eaf61af67369ef02d5c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac831df3647a47d9b7055a7fcf48e5404"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#ac831df3647a47d9b7055a7fcf48e5404">Get</a> (<a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> *buffer, size_t) const =0</td></tr>
<tr class="separator:ac831df3647a47d9b7055a7fcf48e5404"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e8870dbda86ef67bee730510f3dd006"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a2e8870dbda86ef67bee730510f3dd006">Get</a> (<a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> *buffer, size_t, size_t) const =0</td></tr>
<tr class="separator:a2e8870dbda86ef67bee730510f3dd006"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fdd1975e77a4be34bda5f41c319dac7"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a1fdd1975e77a4be34bda5f41c319dac7">GetRawUnicodeText</a> () const =0</td></tr>
<tr class="separator:a1fdd1975e77a4be34bda5f41c319dac7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0359871e23eab9fd7c6ecb6ee434650a"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a0359871e23eab9fd7c6ecb6ee434650a">GetRawUnicodeTextItem</a> (size_t) const =0</td></tr>
<tr class="separator:a0359871e23eab9fd7c6ecb6ee434650a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ea1e3243600cfc2f05263f914437ecc"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a7ea1e3243600cfc2f05263f914437ecc">Add</a> (const <a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> *)=0</td></tr>
<tr class="separator:a7ea1e3243600cfc2f05263f914437ecc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a6f7d407fa0a88cc792fceb2c9b1e5b"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a7a6f7d407fa0a88cc792fceb2c9b1e5b">Set</a> (const <a class="el" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> *, size_t)=0</td></tr>
<tr class="separator:a7a6f7d407fa0a88cc792fceb2c9b1e5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1d3e3730436cf1893f4a1ea121dd5d2"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#ae1d3e3730436cf1893f4a1ea121dd5d2">Get</a> (<a class="el" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> *, size_t) const =0</td></tr>
<tr class="separator:ae1d3e3730436cf1893f4a1ea121dd5d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2ad64c889eae4aa614a85d0aa38b2ab"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#ac2ad64c889eae4aa614a85d0aa38b2ab">GetRawBinary</a> () const =0</td></tr>
<tr class="separator:ac2ad64c889eae4aa614a85d0aa38b2ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61d35ba1108517376632e06db6a9e02a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a61d35ba1108517376632e06db6a9e02a">FromFile</a> (const char *)=0</td></tr>
<tr class="separator:a61d35ba1108517376632e06db6a9e02a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a589764a2865b094300b9cf1339d4dad5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a589764a2865b094300b9cf1339d4dad5">ToFile</a> (const char *sInfo) const =0</td></tr>
<tr class="separator:a589764a2865b094300b9cf1339d4dad5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a074305f2958e594fb6b7b6ed5bed36f5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_i_d3___field.html">ID3_Field</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a074305f2958e594fb6b7b6ed5bed36f5">operator=</a> (const <a class="el" href="class_i_d3___field.html">ID3_Field</a> &)=0</td></tr>
<tr class="separator:a074305f2958e594fb6b7b6ed5bed36f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade2b9184024c1f62e17067253f4adb49"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#ade2b9184024c1f62e17067253f4adb49">InScope</a> (<a class="el" href="globals_8h.html#a48b13eb6cb3c520195901516dee1e612">ID3_V2Spec</a> spec) const =0</td></tr>
<tr class="separator:ade2b9184024c1f62e17067253f4adb49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4bb8d97fddba3a01eb744ab323b43bd2"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c">ID3_FieldID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a4bb8d97fddba3a01eb744ab323b43bd2">GetID</a> () const =0</td></tr>
<tr class="separator:a4bb8d97fddba3a01eb744ab323b43bd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a436aac51a487d2b3e539514a11e5d2c1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="globals_8h.html#adc0ffe8cf70623e6d4d17092b20bdd6b">ID3_FieldType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a436aac51a487d2b3e539514a11e5d2c1">GetType</a> () const =0</td></tr>
<tr class="separator:a436aac51a487d2b3e539514a11e5d2c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f3b7f8b5ee007ee64caa133804c38f2"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a9f3b7f8b5ee007ee64caa133804c38f2">SetEncoding</a> (<a class="el" href="globals_8h.html#a2a414b8e1666bd6dd8dce86cdcf74a39">ID3_TextEnc</a> enc)=0</td></tr>
<tr class="separator:a9f3b7f8b5ee007ee64caa133804c38f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a524fc008d3f7cfb458ccf3cf25d28875"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="globals_8h.html#a2a414b8e1666bd6dd8dce86cdcf74a39">ID3_TextEnc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a524fc008d3f7cfb458ccf3cf25d28875">GetEncoding</a> () const =0</td></tr>
<tr class="separator:a524fc008d3f7cfb458ccf3cf25d28875"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8aae078028573c0c0d6e1e3a9ed3010c"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a8aae078028573c0c0d6e1e3a9ed3010c">IsEncodable</a> () const =0</td></tr>
<tr class="separator:a8aae078028573c0c0d6e1e3a9ed3010c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aedea15255b498f5abbc5c0ac29c6b025"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#aedea15255b498f5abbc5c0ac29c6b025">Render</a> (<a class="el" href="class_i_d3___writer.html">ID3_Writer</a> &) const =0</td></tr>
<tr class="separator:aedea15255b498f5abbc5c0ac29c6b025"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8af818e37c58481084be6bd672a8f34f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a8af818e37c58481084be6bd672a8f34f">Parse</a> (<a class="el" href="class_i_d3___reader.html">ID3_Reader</a> &)=0</td></tr>
<tr class="separator:a8af818e37c58481084be6bd672a8f34f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74463dd7e53fdc6fdd2e180c85e620f5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a74463dd7e53fdc6fdd2e180c85e620f5">HasChanged</a> () const =0</td></tr>
<tr class="separator:a74463dd7e53fdc6fdd2e180c85e620f5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:accd96a7466928e0aaef519c3ff3bf5df"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#accd96a7466928e0aaef519c3ff3bf5df">~ID3_Field</a> ()</td></tr>
<tr class="separator:accd96a7466928e0aaef519c3ff3bf5df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b1bbb304814bef2c1b4e76fa27c6617"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___field.html#a2b1bbb304814bef2c1b4e76fa27c6617">ID3_Field</a> ()</td></tr>
<tr class="separator:a2b1bbb304814bef2c1b4e76fa27c6617"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The representative class of an ID3v2 field. </p>
<p>As a general rule, you need never create an object of this type. id3lib uses them internally as part of the id3_frame class. You must know how to interact with these objects, though, and that's what this section is about.</p>
<p>The <a class="el" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a> contains many overloaded methods to provide these facilities for four different data types: integers, ASCII strings, Unicode strings, and binary data.</p>
<p>An integer field supports the <a class="el" href="class_i_d3___field.html#a363d1034fb4e60e85f15bcf9818d33ef" title="Returns the value of the integer field.">Get()</a>, <a class="el" href="class_i_d3___field.html#a16387cf6c54df5432a0c048d6a931f03">Set(uint32)</a>, and <a class="el" href="class_i_d3___field.html#a2431905ed199a8c541a970986d0735a7" title="A shortcut for the Set method.">operator=(uint32)</a> methods.</p>
<p>Both types of strings support the <a class="el" href="class_i_d3___field.html#a9d3c0e640a68fee3afc2498944027b86">GetNumTextItems()</a> method.</p>
<p>An ASCII string field supports the Get(char*, size_t, size_t)), <a class="el" href="class_i_d3___field.html#a55ea11a70916093009ebbd6628bf690e">Set(const char*)</a>, <a class="el" href="class_i_d3___field.html#ade699be00ad543bf60bafb7fc9c0122a">Add(const char*)</a>, and <a class="el" href="class_i_d3___field.html#a1afc1275f1c9fdf8d46c8801c0160696" title="Shortcut for the Set operator.">operator=(const char*)</a> methods.</p>
<p>A Unicode field also supports Get(unicode_t*, size_t, size_t), <a class="el" href="class_i_d3___field.html#afa16f88c3974eaf61af67369ef02d5c1">Set(const unicode_t*)</a>, <a class="el" href="class_i_d3___field.html#a7ea1e3243600cfc2f05263f914437ecc">Add(const unicode_t*)</a>, and <a class="el" href="class_i_d3___field.html#ab816bf9e67b17f911b9814fc154414d7" title="Shortcut for the Set operator.">operator=(const unicode_t*)</a>. Without elaborating, the Unicode methods behave exactly the same as their ASCII counterparts, taking <code>unicode_t</code> pointers in place of <code>char</code> pointers.</p>
<p>All strings in id3lib are handled internally as Unicode. This means that when you set a field with an ASCII source type, it will be converted and stored internally as a Unicode string. id3lib will handle all necessary conversions when parsing, rendering, and retrieving. If you set a field as an ASCII string, then try to read the string into a <code>unicode_t</code> buffer, id3lib will automatically convert the string into Unicode so this will function as expected. The same holds true in reverse. Of course, when converting from Unicode to ASCII, you will experience problems when the Unicode string contains characters that don't map to ISO-8859-1.</p>
<p>A binary field supports the Get(uchar*, size_t), <a class="el" href="class_i_d3___field.html#a7a6f7d407fa0a88cc792fceb2c9b1e5b">Set(const uchar*, size_t)</a>, <a class="el" href="class_i_d3___field.html#a61d35ba1108517376632e06db6a9e02a">FromFile(const char*)</a>, and ToFile(const char*) methods. The binary field holds miscellaneous data that can't easily be described any other way, such as a JPEG image.</p>
<p>As a general implementation note, you should be prepared to support all fields in an id3lib frame, even if all fields in the id3lib version of the frame aren't present in the id3v2 version. This is because of frames like the picture frame, which changed slightly from one version of the id3v2 standard to the next (the IMAGEFORMAT format in 2.0 changed to a MIMETYPE in 3.0). If you support all id3lib fields in a given frame, id3lib can generate the correct id3v2 frame for the id3v2 version you wish to support. Alternatively, just support the fields you know will be used in, say, 3.0 if you only plan to generate 3.0 tags.</p>
<dl class="section author"><dt>Author</dt><dd>Dirk Mahoney </dd></dl>
<dl class="section version"><dt>Version</dt><dd></dd></dl>
<dl class="section rcs"><dt>Id:</dt><dd><a class="el" href="field_8cpp.html">field.cpp</a>,v 1.47 2002/11/03 00:41:27 t1mpy Exp </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a> </dd>
<dd>
<a class="el" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a> </dd>
<dd>
<a class="el" href="globals_8h.html#a0b8e76d7ef771f36346f7e4e5ce3fa84" title="Predefined id3lib error types.">ID3_Err</a> </dd></dl>
<p>Definition at line <a class="el" href="field_8h_source.html#l00036">36</a> of file <a class="el" href="field_8h_source.html">field.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="accd96a7466928e0aaef519c3ff3bf5df"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ID3_Field::~ID3_Field </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="field_8h_source.html#l00090">90</a> of file <a class="el" href="field_8h_source.html">field.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2b1bbb304814bef2c1b4e76fa27c6617"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ID3_Field::ID3_Field </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="field_8h_source.html#l00093">93</a> of file <a class="el" href="field_8h_source.html">field.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ade699be00ad543bf60bafb7fc9c0122a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::Add </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a0493b19b836899394d02839bd14d1e28">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a7ea1e3243600cfc2f05263f914437ecc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::Add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a46406170d406d52ad395817fd483a50d">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="aefa9e7690d7097ec315b029e31eb1973"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::BinSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#ad8ed1cf546dad93f12585e14589c3ffc">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a1de0019592f57cdc7a3215ce2122e671"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ID3_Field::Clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a70599ecbe8fc8a4a55c348a15bcb3928">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a61d35ba1108517376632e06db6a9e02a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ID3_Field::FromFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#afed9225149cd16de682c231fb31122dd">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a363d1034fb4e60e85f15bcf9818d33ef"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32 ID3_Field::Get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the value of the integer field. </p>
<div class="fragment"><div class="line">uint32 picType = myFrame.GetField(<a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2cacf3efb9534c1200db2f003f5837bb1ad" title="Picture type field.">ID3FN_PICTURETYPE</a>)->Get();</div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>The value of the integer field </dd></dl>
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#ab0e321c609325a38f29bc279bfb7b2be">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ad57d9cfe6175c1a53c483edbc2ac814f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::Get </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#aff27e177c13c8e06120af2ef3f91e2f8">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ad5c8fe7d909fdf52b5a6eb2538a39dc2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::Get </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a0bd3e89ee529f3b35e0591b7f31142ef">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ac831df3647a47d9b7055a7fcf48e5404"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::Get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a0b39bf7b3c161471b3ac94b6eec90014">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a2e8870dbda86ef67bee730510f3dd006"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::Get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#abddb3eb765d1659d58484606a66f938f">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ae1d3e3730436cf1893f4a1ea121dd5d2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::Get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a0f5cc37356a498c53ad0245dbcac8bb1">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a524fc008d3f7cfb458ccf3cf25d28875"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="globals_8h.html#a2a414b8e1666bd6dd8dce86cdcf74a39">ID3_TextEnc</a> ID3_Field::GetEncoding </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a3c56d7c248d7e5c5e4fd210ea8ec1ee6">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a4bb8d97fddba3a01eb744ab323b43bd2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c">ID3_FieldID</a> ID3_Field::GetID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a8a69e4ae76206e64d8f2e25588b60671">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a9d3c0e640a68fee3afc2498944027b86"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::GetNumTextItems </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a0232e29cabdf6761a033216e3ce580cd">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ac2ad64c889eae4aa614a85d0aa38b2ab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a>* ID3_Field::GetRawBinary </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a818191aad4980b504c141ac35d3e0f0a">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a1b306f45543afd5459e77200a0fc0a1f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* ID3_Field::GetRawText </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a919d4edfb70125f3b17b2708dde10ba9">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="aae05e22d1918f2265d9fb0970ef5f09d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* ID3_Field::GetRawTextItem </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#ac8c4f35492f4f4fd9845657368a14544">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a1fdd1975e77a4be34bda5f41c319dac7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a>* ID3_Field::GetRawUnicodeText </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#ab8c9fd2ac15148731126895883532167">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a0359871e23eab9fd7c6ecb6ee434650a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a>* ID3_Field::GetRawUnicodeTextItem </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a0b749211804be718ea62a216492944e6">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a436aac51a487d2b3e539514a11e5d2c1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="globals_8h.html#adc0ffe8cf70623e6d4d17092b20bdd6b">ID3_FieldType</a> ID3_Field::GetType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a52bf3b506788dbfb3adad6af6c413b90">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a74463dd7e53fdc6fdd2e180c85e620f5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ID3_Field::HasChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a0c8fa8497ca4efee015b136bc120cef3">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ade2b9184024c1f62e17067253f4adb49"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ID3_Field::InScope </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a48b13eb6cb3c520195901516dee1e612">ID3_V2Spec</a> </td>
<td class="paramname"><em>spec</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#ad92caf31d6bb68c4713bdcecde2ce2dd">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a8aae078028573c0c0d6e1e3a9ed3010c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ID3_Field::IsEncodable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a21f0a2158cb12a3a22f5ee98316d3d1b">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a2431905ed199a8c541a970986d0735a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_i_d3___field.html">ID3_Field</a> & ID3_Field::operator= </td>
<td>(</td>
<td class="paramtype">uint32 </td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A shortcut for the Set method. </p>
<div class="fragment"><div class="line">myFrame.GetField(<a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2cacf3efb9534c1200db2f003f5837bb1ad" title="Picture type field.">ID3FN_PICTURETYPE</a>)->= 0x0B;</div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">val</td><td>The data to assign to this field </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_i_d3___field.html#a16387cf6c54df5432a0c048d6a931f03">Set(uint32)</a> </dd></dl>
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a57d13aefd6006a7d2322c49751254f51">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a1afc1275f1c9fdf8d46c8801c0160696"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_i_d3___field.html">ID3_Field</a> & ID3_Field::operator= </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shortcut for the Set operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The string to assign to this field </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_i_d3___field.html#a55ea11a70916093009ebbd6628bf690e">Set(const char*)</a> </dd></dl>
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a6bc19baaf0841c38b62a75f6585673f1">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ab816bf9e67b17f911b9814fc154414d7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_i_d3___field.html">ID3_Field</a> & ID3_Field::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shortcut for the Set operator. </p>
<p>Performs similarly as <a class="el" href="class_i_d3___field.html#a1afc1275f1c9fdf8d46c8801c0160696" title="Shortcut for the Set operator.">operator=(const char*)</a>, taking a unicode_t string as a parameter rather than an ascii string. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_i_d3___field.html#afa16f88c3974eaf61af67369ef02d5c1">Set(const unicode_t*)</a> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>The string to assign to the field </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a63ab4b732b49ea3666432fa3e5fbed72">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a074305f2958e594fb6b7b6ed5bed36f5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_i_d3___field.html">ID3_Field</a>& ID3_Field::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_i_d3___field.html">ID3_Field</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#afd227474bd984f96dab457c65798776a">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a8af818e37c58481084be6bd672a8f34f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ID3_Field::Parse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_i_d3___reader.html">ID3_Reader</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#ac48d30e0d0b992ae77194fba00b6e527">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="aedea15255b498f5abbc5c0ac29c6b025"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ID3_Field::Render </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_i_d3___writer.html">ID3_Writer</a> & </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#afabade611f293c4b29bf6df3aff2b5a2">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a16387cf6c54df5432a0c048d6a931f03"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ID3_Field::Set </td>
<td>(</td>
<td class="paramtype">uint32 </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a6daa86b940122734d9bee75d7b57d6cf">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a55ea11a70916093009ebbd6628bf690e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::Set </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#af2d525110fda890ff94dd86d7806c23a">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="afa16f88c3974eaf61af67369ef02d5c1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::Set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a5e4ebdb241a1dde45d7b1f17ed4b7b99">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a7a6f7d407fa0a88cc792fceb2c9b1e5b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t ID3_Field::Set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a6ba3623febd59f599ba7b4f0df2f9904">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a9f3b7f8b5ee007ee64caa133804c38f2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ID3_Field::SetEncoding </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a2a414b8e1666bd6dd8dce86cdcf74a39">ID3_TextEnc</a> </td>
<td class="paramname"><em>enc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#ae5f150e7c959f6ce20adcc5aa6e29e7a">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a4eed557e9f540d3c9347ac31f0f8e55b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t ID3_Field::Size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the size of a field. </p>
<p>The value returned is dependent on the type of the field. For ASCII strings, this returns the number of characters in the field, not including any NULL-terminator. The same holds true for Unicode—it returns the number of characters in the field, not bytes, and this does not include the Unicode BOM, which isn't put in a Unicode string obtained by the Get(unicode_t*, size_t, size_t) method anyway. For binary and integer fields, this returns the number of bytes in the field.</p>
<div class="fragment"><div class="line"><span class="keywordtype">size_t</span> howBig = myFrame.GetField(<a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2cabd5e1e87686d7a1fc9ba291023e9ccc0" title="Data field.">ID3FN_DATA</a>)->Size();</div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>The size of the field, either in bytes (for binary or integer fields) or characters (for strings). </dd></dl>
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a42c87589e147efabe0e2eb30bdc6938b">ID3_FieldImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a589764a2865b094300b9cf1339d4dad5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ID3_Field::ToFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>sInfo</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_i_d3___field_impl.html#a1100cfc61ac54906dfb95891beb972d0">ID3_FieldImpl</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/id3/<a class="el" href="field_8h_source.html">field.h</a></li>
<li>src/<a class="el" href="field_8cpp_source.html">field.cpp</a></li>
<li>src/<a class="el" href="field__integer_8cpp_source.html">field_integer.cpp</a></li>
<li>src/<a class="el" href="field__string__ascii_8cpp_source.html">field_string_ascii.cpp</a></li>
<li>src/<a class="el" href="field__string__unicode_8cpp_source.html">field_string_unicode.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 5 2013 19:40:29 for id3lib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>
