![]() |
|
#include <tableofcontentsframe.h>
This is an implementation of ID3v2 table of contents frames. Purpose of this frame is to allow a table of contents to be defined.
TagLib::ID3v2::TableOfContentsFrame::TableOfContentsFrame | ( | const ID3v2::Header * | tagHeader, | |
const ByteVector & | data | |||
) |
Creates a table of contents frame based on data. tagHeader is required as the internal frames are parsed based on the tag version.
TagLib::ID3v2::TableOfContentsFrame::TableOfContentsFrame | ( | const ByteVector & | elementID, | |
const ByteVectorList & | children = ByteVectorList() , |
|||
const FrameList & | embeddedFrames = FrameList() | |||
) |
Creates a table of contents frame with the element ID elementID, the child elements children and embedded frames, which become owned by this frame, in embeddedFrames.
TagLib::ID3v2::TableOfContentsFrame::~TableOfContentsFrame | ( | ) |
Destroys the frame.
ByteVector TagLib::ID3v2::TableOfContentsFrame::elementID | ( | ) | const |
Returns the elementID of the frame. Element ID is a null terminated string, however it's not human-readable.
bool TagLib::ID3v2::TableOfContentsFrame::isTopLevel | ( | ) | const |
Returns true, if the frame is top-level (doesn't have any parent CTOC frame).
bool TagLib::ID3v2::TableOfContentsFrame::isOrdered | ( | ) | const |
unsigned int TagLib::ID3v2::TableOfContentsFrame::entryCount | ( | ) | const |
Returns count of child elements of the frame. It always corresponds to size of child elements list.
ByteVectorList TagLib::ID3v2::TableOfContentsFrame::childElements | ( | ) | const |
void TagLib::ID3v2::TableOfContentsFrame::setElementID | ( | const ByteVector & | eID | ) |
Sets the elementID of the frame to eID. If eID isn't null terminated, a null char is appended automatically.
void TagLib::ID3v2::TableOfContentsFrame::setIsTopLevel | ( | const bool & | t | ) |
void TagLib::ID3v2::TableOfContentsFrame::setIsOrdered | ( | const bool & | o | ) |
void TagLib::ID3v2::TableOfContentsFrame::setChildElements | ( | const ByteVectorList & | l | ) |
void TagLib::ID3v2::TableOfContentsFrame::addChildElement | ( | const ByteVector & | cE | ) |
void TagLib::ID3v2::TableOfContentsFrame::removeChildElement | ( | const ByteVector & | cE | ) |
const FrameListMap& TagLib::ID3v2::TableOfContentsFrame::embeddedFrameListMap | ( | ) | const |
Returns a reference to the frame list map. This is an FrameListMap of all of the frames embedded in the CTOC frame.
This is the most convenient structure for accessing the CTOC frame's embedded frames. Many frame types allow multiple instances of the same frame type so this is a map of lists. In most cases however there will only be a single frame of a certain type.
const FrameList& TagLib::ID3v2::TableOfContentsFrame::embeddedFrameList | ( | ) | const |
Returns a reference to the embedded frame list. This is an FrameList of all of the frames embedded in the CTOC frame in the order that they were parsed.
This can be useful if for example you want iterate over the CTOC frame's embedded frames in the order that they occur in the CTOC frame.
const FrameList& TagLib::ID3v2::TableOfContentsFrame::embeddedFrameList | ( | const ByteVector & | frameID | ) | const |
Returns the embedded frame list for frames with the id frameID or an empty list if there are no embedded frames of that type. This is just a convenience and is equivalent to:
void TagLib::ID3v2::TableOfContentsFrame::addEmbeddedFrame | ( | Frame * | frame | ) |
Add an embedded frame to the CTOC frame. At this point the CTOC frame takes ownership of the embedded frame and will handle freeing its memory.
void TagLib::ID3v2::TableOfContentsFrame::removeEmbeddedFrame | ( | Frame * | frame, | |
bool | del = true | |||
) |
Remove an embedded frame from the CTOC frame. If del is true the frame's memory will be freed; if it is false, it must be deleted by the user.
void TagLib::ID3v2::TableOfContentsFrame::removeEmbeddedFrames | ( | const ByteVector & | id | ) |
Remove all embedded frames of type id from the CTOC frame and free their memory.
virtual String TagLib::ID3v2::TableOfContentsFrame::toString | ( | ) | const [virtual] |
This returns the textual representation of the data in the frame. Subclasses must reimplement this method to provide a string representation of the frame's data.
Implements TagLib::ID3v2::Frame.
PropertyMap TagLib::ID3v2::TableOfContentsFrame::asProperties | ( | ) | const |
Parses the contents of this frame as PropertyMap. If that fails, the returend PropertyMap will be empty, and its unsupportedData() will contain this frame's ID. BIC: Will be a virtual function in future releases.
Reimplemented from TagLib::ID3v2::Frame.
static TableOfContentsFrame* TagLib::ID3v2::TableOfContentsFrame::findByElementID | ( | const Tag * | tag, | |
const ByteVector & | eID | |||
) | [static] |
CTOC frames each have a unique element ID. This searches for a CTOC frame with the element ID eID and returns a pointer to it. This can be used to link together parent and child CTOC frames.
static TableOfContentsFrame* TagLib::ID3v2::TableOfContentsFrame::findTopLevel | ( | const Tag * | tag | ) | [static] |
CTOC frames each contain a flag that indicates, if CTOC frame is top-level (there isn't any frame, which contains this frame in its child elements list). Only a single frame within tag can be top-level. This searches for a top-level CTOC frame.
virtual void TagLib::ID3v2::TableOfContentsFrame::parseFields | ( | const ByteVector & | data | ) | [protected, virtual] |
Called by parse() to parse the field data. It makes this information available through the public API. This must be overridden by the subclasses.
Implements TagLib::ID3v2::Frame.
virtual ByteVector TagLib::ID3v2::TableOfContentsFrame::renderFields | ( | ) | const [protected, virtual] |
Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.
Implements TagLib::ID3v2::Frame.
friend class FrameFactory [friend] |
Reimplemented from TagLib::ID3v2::Frame.