Sophie

Sophie

distrib > Fedora > 18 > i386 > by-pkgid > 7528ff8b241faf6d158e12599972eb96 > files > 577

taglib-doc-1.8-3.20121215git.fc18.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>commentsframe.h Source File (TagLib)</title>
    <link href="taglib-api.css" rel="stylesheet" type="text/css">
  </head>
  <body>
    <div id="container">
      <table border="0" width="100%">
          <tr>
            <td width="1">
              <img src="../taglib.png">
            </td>
            <td>
              <div id="intro">
                <table border="0" height="119" cellpadding="0" cellspacing="0" width="100%">
                    <tr><td valign="top"><h1>TagLib 1.8.0 (commentsframe.h Source File)</h1></td></tr>
                    <tr>
                      <td valign="bottom">
                        <div id="links">
                          <a href="index.html">Home</a>
                          <a href="inherits.html">Class&nbsp;Hierarchy</a>
                          <a href="namespaces.html">Namespaces</a>
                          <a href="annotated.html">Classes</a>
                          <a href="files.html">Headers</a>
                          <a href="namespacemembers.html">Namespace&nbsp;Members</a>
                          <a href="functions.html">Class&nbsp;Members</a>
                          <a href="globals.html">File&nbsp;Members</a>
                        </div>
                      </td>
                    </tr>
                </table>
              </div>
            </td>
          </tr>
      </table>
      <div id="text">
<!-- Generated by Doxygen 1.8.3 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_b83727240c17e6d2210e34d27bf7473a.html">taglib</a></li><li class="navelem"><a class="el" href="dir_12d522bcf18d6cb9104a7437cf9eaff6.html">mpeg</a></li><li class="navelem"><a class="el" href="dir_50c2148aaf2ea51c32cf36d242fc4768.html">id3v2</a></li><li class="navelem"><a class="el" href="dir_b671db08368225ca1b6e943c0c2b1952.html">frames</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">commentsframe.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="commentsframe_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/***************************************************************************</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">    copyright            : (C) 2002 - 2008 by Scott Wheeler</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">    email                : wheeler@kde.org</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> ***************************************************************************/</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;</div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">/***************************************************************************</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *   This library is free software; you can redistribute it and/or modify  *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *   it under the terms of the GNU Lesser General Public License version   *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *   2.1 as published by the Free Software Foundation.                     *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *                                                                         *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *   This library is distributed in the hope that it will be useful, but   *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *   WITHOUT ANY WARRANTY; without even the implied warranty of            *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *   Lesser General Public License for more details.                       *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *                                                                         *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *   You should have received a copy of the GNU Lesser General Public      *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *   License along with this library; if not, write to the Free Software   *</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> *   02110-1301  USA                                                       *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> *                                                                         *</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> *   Alternatively, this file is available under the Mozilla Public        *</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *   License Version 1.1.  You may obtain a copy of the License at         *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> *   http://www.mozilla.org/MPL/                                           *</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> ***************************************************************************/</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#ifndef TAGLIB_COMMENTSFRAME_H</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define TAGLIB_COMMENTSFRAME_H</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="id3v2frame_8h.html">id3v2frame.h</a>&quot;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="taglib__export_8h.html">taglib_export.h</a>&quot;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">namespace </span>TagLib {</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;  <span class="keyword">namespace </span>ID3v2 {</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html">   43</a></span>&#160;    <span class="keyword">class </span><a class="code" href="taglib__export_8h.html#a869a58b518ef871f14a9b4ccfe86ecfb">TAGLIB_EXPORT</a> <a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html" title="An implementation of ID3v2 comments.">CommentsFrame</a> : <span class="keyword">public</span> <a class="code" href="classTagLib_1_1ID3v2_1_1Frame.html" title="ID3v2 frame implementation.">Frame</a></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    {</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html#a98931185c3f9519c3afbee533f80487e">   45</a></span>&#160;      <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classTagLib_1_1ID3v2_1_1FrameFactory.html" title="A factory for creating ID3v2 frames during parsing.">FrameFactory</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;      <span class="keyword">explicit</span> <a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html" title="An implementation of ID3v2 comments.">CommentsFrame</a>(<a class="code" href="classTagLib_1_1String.html#ab94f467aa0f37f21c8314ec2f3bc063b">String::Type</a> encoding = <a class="code" href="classTagLib_1_1String.html#ab94f467aa0f37f21c8314ec2f3bc063ba1529972fb3e3fd8fd14b6648c76d7fd8">String::Latin1</a>);</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;      <span class="keyword">explicit</span> <a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html" title="An implementation of ID3v2 comments.">CommentsFrame</a>(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1ByteVector.html" title="A byte vector.">ByteVector</a> &amp;data);</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;      <span class="keyword">virtual</span> ~<a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html" title="An implementation of ID3v2 comments.">CommentsFrame</a>();</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;      <span class="keyword">virtual</span> <a class="code" href="classTagLib_1_1String.html" title="A wide string class suitable for unicode.">String</a> toString() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;      <a class="code" href="classTagLib_1_1ByteVector.html" title="A byte vector.">ByteVector</a> language() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;      <a class="code" href="classTagLib_1_1String.html" title="A wide string class suitable for unicode.">String</a> description() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;      <a class="code" href="classTagLib_1_1String.html" title="A wide string class suitable for unicode.">String</a> text() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;      <span class="keywordtype">void</span> setLanguage(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1ByteVector.html" title="A byte vector.">ByteVector</a> &amp;languageCode);</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;      <span class="keywordtype">void</span> setDescription(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1String.html" title="A wide string class suitable for unicode.">String</a> &amp;s);</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;      <span class="keyword">virtual</span> <span class="keywordtype">void</span> setText(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1String.html" title="A wide string class suitable for unicode.">String</a> &amp;s);</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;      <a class="code" href="classTagLib_1_1String.html#ab94f467aa0f37f21c8314ec2f3bc063b">String::Type</a> textEncoding() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;      <span class="keywordtype">void</span> setTextEncoding(<a class="code" href="classTagLib_1_1String.html#ab94f467aa0f37f21c8314ec2f3bc063b">String::Type</a> encoding);</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;      <a class="code" href="classTagLib_1_1PropertyMap.html" title="A map for format-independent &lt;key,valuelist&gt; tag representations.">PropertyMap</a> asProperties() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;      <span class="keyword">static</span> <a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html" title="An implementation of ID3v2 comments.">CommentsFrame</a> *findByDescription(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1ID3v2_1_1Tag.html" title="The main class in the ID3v2 implementation.">Tag</a> *tag, <span class="keyword">const</span> <a class="code" href="classTagLib_1_1String.html" title="A wide string class suitable for unicode.">String</a> &amp;d);</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;    <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;      <span class="comment">// Reimplementations.</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;      <span class="keyword">virtual</span> <span class="keywordtype">void</span> parseFields(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1ByteVector.html" title="A byte vector.">ByteVector</a> &amp;data);</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;      <span class="keyword">virtual</span> <a class="code" href="classTagLib_1_1ByteVector.html" title="A byte vector.">ByteVector</a> renderFields() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;    <span class="keyword">private</span>:</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;      <a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html" title="An implementation of ID3v2 comments.">CommentsFrame</a>(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1ByteVector.html" title="A byte vector.">ByteVector</a> &amp;data, <a class="code" href="classTagLib_1_1ID3v2_1_1Header.html" title="An implementation of ID3v2 headers.">Header</a> *h);</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;      <a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html" title="An implementation of ID3v2 comments.">CommentsFrame</a>(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html" title="An implementation of ID3v2 comments.">CommentsFrame</a> &amp;);</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;      <a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html" title="An implementation of ID3v2 comments.">CommentsFrame</a> &amp;operator=(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1ID3v2_1_1CommentsFrame.html" title="An implementation of ID3v2 comments.">CommentsFrame</a> &amp;);</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;      <span class="keyword">class </span>CommentsFramePrivate;</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;      CommentsFramePrivate *d;</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;    };</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;  }</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;}</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
      </div>
    </div>
  </body>
</html>