tableofcontentsframe.h
Go to the documentation of this file.
1 /***************************************************************************
2  copyright : (C) 2013 by Lukas Krejci
3  email : krejclu6@fel.cvut.cz
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_TABLEOFCONTENTSFRAME
27 #define TAGLIB_TABLEOFCONTENTSFRAME
28 
29 #include "id3v2tag.h"
30 #include "id3v2frame.h"
31 
32 #include "tbytevectorlist.h"
33 
34 namespace TagLib {
35 
36  namespace ID3v2 {
37 
44 
46  {
47  friend class FrameFactory;
48 
49  public:
54  TableOfContentsFrame(const ID3v2::Header *tagHeader, const ByteVector &data);
55 
61  TableOfContentsFrame(const ByteVector &elementID,
62  const ByteVectorList &children = ByteVectorList(),
63  const FrameList &embeddedFrames = FrameList());
64 
69 
77 
84  bool isTopLevel() const;
85 
92  bool isOrdered() const;
93 
100  unsigned int entryCount() const;
101 
108 
115  void setElementID(const ByteVector &eID);
116 
123  void setIsTopLevel(const bool &t);
124 
131  void setIsOrdered(const bool &o);
132 
139 
145  void addChildElement(const ByteVector &cE);
146 
153 
169 
181  const FrameList &embeddedFrameList() const;
182 
194  const FrameList &embeddedFrameList(const ByteVector &frameID) const;
195 
203  void addEmbeddedFrame(Frame *frame);
204 
212  void removeEmbeddedFrame(Frame *frame, bool del = true);
213 
222 
223  virtual String toString() const;
224 
226 
234  static TableOfContentsFrame *findByElementID(const Tag *tag, const ByteVector &eID);
235 
243  static TableOfContentsFrame *findTopLevel(const Tag *tag);
244 
245  protected:
246  virtual void parseFields(const ByteVector &data);
247  virtual ByteVector renderFields() const;
248 
249  private:
250  TableOfContentsFrame(const ID3v2::Header *tagHeader, const ByteVector &data, Header *h);
252  TableOfContentsFrame &operator=(const TableOfContentsFrame &);
253 
254  class TableOfContentsFramePrivate;
255  TableOfContentsFramePrivate *d;
256  };
257  }
258 }
259 
260 #endif
A list of ByteVectors.
Definition: tbytevectorlist.h:42
A byte vector.
Definition: tbytevector.h:46
A factory for creating ID3v2 frames during parsing.
Definition: id3v2framefactory.h:66
ID3v2 frame implementation.
Definition: id3v2frame.h:55
An implementation of ID3v2 headers.
Definition: id3v2header.h:49
An implementation of ID3v2 table of contents frames.
Definition: tableofcontentsframe.h:46
void removeChildElement(const ByteVector &cE)
void setElementID(const ByteVector &eID)
static TableOfContentsFrame * findByElementID(const Tag *tag, const ByteVector &eID)
virtual ByteVector renderFields() const
virtual String toString() const
TableOfContentsFrame(const ID3v2::Header *tagHeader, const ByteVector &data)
virtual void parseFields(const ByteVector &data)
const FrameList & embeddedFrameList() const
void addChildElement(const ByteVector &cE)
const FrameList & embeddedFrameList(const ByteVector &frameID) const
const FrameListMap & embeddedFrameListMap() const
ByteVectorList childElements() const
TableOfContentsFrame(const ByteVector &elementID, const ByteVectorList &children=ByteVectorList(), const FrameList &embeddedFrames=FrameList())
void removeEmbeddedFrames(const ByteVector &id)
static TableOfContentsFrame * findTopLevel(const Tag *tag)
void removeEmbeddedFrame(Frame *frame, bool del=true)
void setChildElements(const ByteVectorList &l)
The main class in the ID3v2 implementation.
Definition: id3v2tag.h:128
A generic, implicitly shared list.
Definition: tlist.h:54
A generic, implicitly shared map.
Definition: tmap.h:44
A map for format-independent <key,valuelist> tag representations.
Definition: tpropertymap.h:114
A wide string class suitable for unicode.
Definition: tstring.h:85
List< Frame * > FrameList
Definition: id3v2tag.h:47
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
#define TAGLIB_EXPORT
Definition: taglib_export.h:40