| TagLib 1.13 |  |

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
43 class TAGLIB_EXPORT CommentsFrame : public Frame
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
TagLib::ByteVector
A byte vector.
Definition: tbytevector.h:46
TagLib::ID3v2::CommentsFrame
An implementation of ID3v2 comments.
Definition: commentsframe.h:44
TagLib::ID3v2::CommentsFrame::asProperties
PropertyMap asProperties() const
TagLib::ID3v2::CommentsFrame::setLanguage
void setLanguage(const ByteVector &languageCode)
TagLib::ID3v2::CommentsFrame::CommentsFrame
CommentsFrame(String::Type encoding=String::Latin1)
TagLib::ID3v2::CommentsFrame::~CommentsFrame
virtual ~CommentsFrame()
TagLib::ID3v2::CommentsFrame::findByDescription
static CommentsFrame * findByDescription(const Tag *tag, const String &d)
TagLib::ID3v2::CommentsFrame::renderFields
virtual ByteVector renderFields() const
TagLib::ID3v2::CommentsFrame::language
ByteVector language() const
TagLib::ID3v2::CommentsFrame::setText
virtual void setText(const String &s)
TagLib::ID3v2::CommentsFrame::CommentsFrame
CommentsFrame(const ByteVector &data)
TagLib::ID3v2::CommentsFrame::setDescription
void setDescription(const String &s)
TagLib::ID3v2::CommentsFrame::setTextEncoding
void setTextEncoding(String::Type encoding)
TagLib::ID3v2::CommentsFrame::toString
virtual String toString() const
TagLib::ID3v2::CommentsFrame::description
String description() const
TagLib::ID3v2::CommentsFrame::textEncoding
String::Type textEncoding() const
TagLib::ID3v2::CommentsFrame::text
String text() const
TagLib::ID3v2::CommentsFrame::parseFields
virtual void parseFields(const ByteVector &data)
TagLib::ID3v2::FrameFactory
A factory for creating ID3v2 frames during parsing.
Definition: id3v2framefactory.h:66
TagLib::ID3v2::Frame
ID3v2 frame implementation.
Definition: id3v2frame.h:55
TagLib::ID3v2::Header
An implementation of ID3v2 headers.
Definition: id3v2header.h:49
TagLib::ID3v2::Tag
The main class in the ID3v2 implementation.
Definition: id3v2tag.h:128
TagLib::PropertyMap
A map for format-independent <key,valuelist> tag representations.
Definition: tpropertymap.h:119
TagLib::String
A wide string class suitable for unicode.
Definition: tstring.h:85
TagLib::String::Type
Type
Definition: tstring.h:97
TagLib::String::Latin1
@ Latin1
Definition: tstring.h:101
id3v2frame.h
TagLib
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
taglib_export.h
TAGLIB_EXPORT
#define TAGLIB_EXPORT
Definition: taglib_export.h:40