![]() |
|
#include <urllinkframe.h>
Public Member Functions | |
UserUrlLinkFrame (String::Type encoding=String::Latin1) | |
UserUrlLinkFrame (const ByteVector &data) | |
virtual | ~UserUrlLinkFrame () |
virtual String | toString () const |
String::Type | textEncoding () const |
void | setTextEncoding (String::Type encoding) |
String | description () const |
void | setDescription (const String &s) |
PropertyMap | asProperties () const |
Static Public Member Functions | |
static UserUrlLinkFrame * | find (Tag *tag, const String &description) |
Protected Member Functions | |
virtual void | parseFields (const ByteVector &data) |
virtual ByteVector | renderFields () const |
UserUrlLinkFrame (const ByteVector &data, Header *h) | |
Friends | |
class | FrameFactory |
This is a specialization of URL link frames that allows for user defined entries. Each entry has a description in addition to the normal list of fields that a URL link frame has.
This description identifies the frame and must be unique.
TagLib::ID3v2::UserUrlLinkFrame::UserUrlLinkFrame | ( | String::Type | encoding = String::Latin1 |
) | [explicit] |
Constructs an empty user defined URL link frame. For this to be a useful frame both a description and text must be set.
TagLib::ID3v2::UserUrlLinkFrame::UserUrlLinkFrame | ( | const ByteVector & | data | ) | [explicit] |
This is a dual purpose constructor. data can either be binary data that should be parsed or (at a minimum) the frame ID.
virtual TagLib::ID3v2::UserUrlLinkFrame::~UserUrlLinkFrame | ( | ) | [virtual] |
Destroys this UserUrlLinkFrame instance.
TagLib::ID3v2::UserUrlLinkFrame::UserUrlLinkFrame | ( | const ByteVector & | data, | |
Header * | h | |||
) | [protected] |
The constructor used by the FrameFactory.
virtual String TagLib::ID3v2::UserUrlLinkFrame::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.
Reimplemented from TagLib::ID3v2::UrlLinkFrame.
String::Type TagLib::ID3v2::UserUrlLinkFrame::textEncoding | ( | ) | const |
Returns the text encoding that will be used in rendering this frame. This defaults to the type that was either specified in the constructor or read from the frame when parsed.
void TagLib::ID3v2::UserUrlLinkFrame::setTextEncoding | ( | String::Type | encoding | ) |
String TagLib::ID3v2::UserUrlLinkFrame::description | ( | ) | const |
Returns the description for this frame.
void TagLib::ID3v2::UserUrlLinkFrame::setDescription | ( | const String & | s | ) |
Sets the description of the frame to s. s must be unique.
PropertyMap TagLib::ID3v2::UserUrlLinkFrame::asProperties | ( | ) | const |
Parses the UserUrlLinkFrame as PropertyMap. The description() is taken as key, and the URL as single value.
Reimplemented from TagLib::ID3v2::UrlLinkFrame.
static UserUrlLinkFrame* TagLib::ID3v2::UserUrlLinkFrame::find | ( | Tag * | tag, | |
const String & | description | |||
) | [static] |
Searches for the user defined url frame with the description description in tag. This returns null if no matching frames were found.
virtual void TagLib::ID3v2::UserUrlLinkFrame::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.
Reimplemented from TagLib::ID3v2::UrlLinkFrame.
virtual ByteVector TagLib::ID3v2::UserUrlLinkFrame::renderFields | ( | ) | const [protected, virtual] |
Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.
Reimplemented from TagLib::ID3v2::UrlLinkFrame.
friend class FrameFactory [friend] |
Reimplemented from TagLib::ID3v2::UrlLinkFrame.