TagLib 1.11.1 (tableofcontentsframe.h Source File)

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 namespace TagLib {
33 
34  namespace ID3v2 {
35 
41 
43  class TAGLIB_EXPORT TableOfContentsFrame : public ID3v2::Frame
44  {
45  friend class FrameFactory;
46 
47  public:
52  TableOfContentsFrame(const ID3v2::Header *tagHeader, const ByteVector &data);
53 
59  TableOfContentsFrame(const ByteVector &elementID,
60  const ByteVectorList &children = ByteVectorList(),
61  const FrameList &embeddedFrames = FrameList());
62 
66  ~TableOfContentsFrame();
67 
74  ByteVector elementID() const;
75 
82  bool isTopLevel() const;
83 
90  bool isOrdered() const;
91 
98  unsigned int entryCount() const;
99 
105  ByteVectorList childElements() const;
106 
113  void setElementID(const ByteVector &eID);
114 
121  void setIsTopLevel(const bool &t);
122 
129  void setIsOrdered(const bool &o);
130 
136  void setChildElements(const ByteVectorList &l);
137 
143  void addChildElement(const ByteVector &cE);
144 
150  void removeChildElement(const ByteVector &cE);
151 
166  const FrameListMap &embeddedFrameListMap() const;
167 
179  const FrameList &embeddedFrameList() const;
180 
192  const FrameList &embeddedFrameList(const ByteVector &frameID) const;
193 
201  void addEmbeddedFrame(Frame *frame);
202 
210  void removeEmbeddedFrame(Frame *frame, bool del = true);
211 
219  void removeEmbeddedFrames(const ByteVector &id);
220 
221  virtual String toString() const;
222 
223  PropertyMap asProperties() const;
224 
232  static TableOfContentsFrame *findByElementID(const Tag *tag, const ByteVector &eID);
233 
241  static TableOfContentsFrame *findTopLevel(const Tag *tag);
242 
243  protected:
244  virtual void parseFields(const ByteVector &data);
245  virtual ByteVector renderFields() const;
246 
247  private:
248  TableOfContentsFrame(const ID3v2::Header *tagHeader, const ByteVector &data, Header *h);
249  TableOfContentsFrame(const TableOfContentsFrame &);
250  TableOfContentsFrame &operator=(const TableOfContentsFrame &);
251 
252  class TableOfContentsFramePrivate;
253  TableOfContentsFramePrivate *d;
254  };
255  }
256 }
257 
258 #endif
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
Map< ByteVector, FrameList > FrameListMap
Definition: id3v2tag.h:79
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
List< Frame * > FrameList
Definition: id3v2tag.h:76