![]() |
|
#include <textidentificationframe.h>
Public Member Functions | |
UserTextIdentificationFrame (String::Type encoding=String::Latin1) | |
UserTextIdentificationFrame (const ByteVector &data) | |
virtual String | toString () const |
String | description () const |
void | setDescription (const String &s) |
StringList | fieldList () const |
void | setText (const String &text) |
void | setText (const StringList &fields) |
Static Public Member Functions | |
static UserTextIdentificationFrame * | find (Tag *tag, const String &description) |
Friends | |
class | FrameFactory |
This is a specialization of text identification frames that allows for user defined entries. Each entry has a description in addition to the normal list of fields that a text identification frame has.
This description identifies the frame and must be unique.
TagLib::ID3v2::UserTextIdentificationFrame::UserTextIdentificationFrame | ( | String::Type | encoding = String::Latin1 |
) | [explicit] |
Constructs an empty user defined text identification frame. For this to be a useful frame both a description and text must be set.
TagLib::ID3v2::UserTextIdentificationFrame::UserTextIdentificationFrame | ( | const ByteVector & | data | ) | [explicit] |
Creates a frame based on data.
String TagLib::ID3v2::UserTextIdentificationFrame::description | ( | ) | const |
Returns the description for this frame.
StringList TagLib::ID3v2::UserTextIdentificationFrame::fieldList | ( | ) | const |
Returns a list of the strings in this frame.
Reimplemented from TagLib::ID3v2::TextIdentificationFrame.
static UserTextIdentificationFrame* TagLib::ID3v2::UserTextIdentificationFrame::find | ( | Tag * | tag, | |
const String & | description | |||
) | [static] |
Searches for the user defined text frame with the description description in tag. This returns null if no matching frames were found.
void TagLib::ID3v2::UserTextIdentificationFrame::setDescription | ( | const String & | s | ) |
Sets the description of the frame to s. s must be unique. You can check for the presence of another user defined text frame of the same type using find() and testing for null.
void TagLib::ID3v2::UserTextIdentificationFrame::setText | ( | const StringList & | l | ) |
Text identification frames are a list of string fields.
This function will accept either a StringList or a String (using the StringList constructor that accepts a single String).
Reimplemented from TagLib::ID3v2::TextIdentificationFrame.
void TagLib::ID3v2::UserTextIdentificationFrame::setText | ( | const String & | text | ) | [virtual] |
Set the text of frame in the sanest way possible. This should only be reimplemented in frames where there is some logical mapping to text.
Reimplemented from TagLib::ID3v2::TextIdentificationFrame.
virtual String TagLib::ID3v2::UserTextIdentificationFrame::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::TextIdentificationFrame.
friend class FrameFactory [friend] |
Reimplemented from TagLib::ID3v2::TextIdentificationFrame.