TagLib API Documentation
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 "taglib_export.h"
30#include "id3v2frame.h"
31
32namespace TagLib {
33
34 namespace ID3v2 {
35
37
44 {
45 friend class FrameFactory;
46
47 public:
53
57 explicit CommentsFrame(const ByteVector &data);
58
62 ~CommentsFrame() override;
63
64 CommentsFrame(const CommentsFrame &) = delete;
66
72 String toString() const override;
73
83
92
98 String text() const;
99
107 void setLanguage(const ByteVector &languageEncoding);
108
114 void setDescription(const String &s);
115
121 void setText(const String &s) override;
122
132
141
151 PropertyMap asProperties() const override;
152
160 static CommentsFrame *findByDescription(const Tag *tag, const String &d);
161
162 protected:
163 // Reimplementations.
164
165 void parseFields(const ByteVector &data) override;
166 ByteVector renderFields() const override;
167
168 private:
172 CommentsFrame(const ByteVector &data, Header *h);
173
174 class CommentsFramePrivate;
176 std::unique_ptr<CommentsFramePrivate> d;
177 };
178
179 } // namespace ID3v2
180} // namespace TagLib
181#endif
A byte vector.
Definition: tbytevector.h:46
An implementation of ID3v2 comments.
Definition: commentsframe.h:44
CommentsFrame(String::Type encoding=String::Latin1)
static CommentsFrame * findByDescription(const Tag *tag, const String &d)
ByteVector language() const
void parseFields(const ByteVector &data) override
CommentsFrame(const ByteVector &data)
void setDescription(const String &s)
void setText(const String &s) override
void setLanguage(const ByteVector &languageEncoding)
CommentsFrame & operator=(const CommentsFrame &)=delete
void setTextEncoding(String::Type encoding)
PropertyMap asProperties() const override
String::Type textEncoding() const
ByteVector renderFields() const override
String toString() const override
CommentsFrame(const CommentsFrame &)=delete
A factory for creating ID3v2 frames during parsing.
Definition: id3v2framefactory.h:68
ID3v2 frame implementation.
Definition: id3v2frame.h:57
An implementation of ID3v2 headers.
Definition: id3v2header.h:49
The main class in the ID3v2 implementation.
Definition: id3v2tag.h:134
A map for format-independent <key,values> tag representations.
Definition: tpropertymap.h:122
A wide string class suitable for unicode.
Definition: tstring.h:83
Type
Definition: tstring.h:96
@ Latin1
Definition: tstring.h:100
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
#define TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
Definition: taglib_export.h:55