commentsframe.h
Go to the documentation of this file.
1 /***************************************************************************
2  copyright : (C) 2002 - 2008 by Scott Wheeler
3  email : wheeler@kde.org
4  ***************************************************************************/
5 
6 /***************************************************************************
7  * This library is free software; you can redistribute it and/or modify *
8  * it under the terms of the GNU Lesser General Public License version *
9  * 2.1 as published by the Free Software Foundation. *
10  * *
11  * This library is distributed in the hope that it will be useful, but *
12  * WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the Free Software *
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
19  * 02110-1301 USA *
20  * *
21  * Alternatively, this file is available under the Mozilla Public *
22  * License Version 1.1. You may obtain a copy of the License at *
23  * http://www.mozilla.org/MPL/ *
24  ***************************************************************************/
25 
26 #ifndef TAGLIB_COMMENTSFRAME_H
27 #define TAGLIB_COMMENTSFRAME_H
28 
29 #include "id3v2frame.h"
30 #include "taglib_export.h"
31 
32 namespace TagLib {
33 
34  namespace ID3v2 {
35 
37 
44  {
45  friend class FrameFactory;
46 
47  public:
52  explicit CommentsFrame(String::Type encoding = String::Latin1);
53 
57  explicit CommentsFrame(const ByteVector &data);
58 
62  virtual ~CommentsFrame();
63 
69  virtual String toString() const;
70 
79  ByteVector language() const;
80 
88  String description() const;
89 
95  String text() const;
96 
104  void setLanguage(const ByteVector &languageCode);
105 
111  void setDescription(const String &s);
112 
118  virtual void setText(const String &s);
119 
128  String::Type textEncoding() const;
129 
137  void setTextEncoding(String::Type encoding);
138 
148  PropertyMap asProperties() const;
149 
157  static CommentsFrame *findByDescription(const Tag *tag, const String &d);
158 
159  protected:
160  // Reimplementations.
161 
162  virtual void parseFields(const ByteVector &data);
163  virtual ByteVector renderFields() const;
164 
165  private:
169  CommentsFrame(const ByteVector &data, Header *h);
170  CommentsFrame(const CommentsFrame &);
171  CommentsFrame &operator=(const CommentsFrame &);
172 
173  class CommentsFramePrivate;
174  CommentsFramePrivate *d;
175  };
176 
177  }
178 }
179 #endif