TagLib::ID3v2::UserTextIdentificationFrame Class Reference
An
ID3v2 custom text identification frame implementationx.
More...
#include <textidentificationframe.h>
Inheritance diagram for TagLib::ID3v2::UserTextIdentificationFrame:
[legend]Collaboration diagram for TagLib::ID3v2::UserTextIdentificationFrame:
[legend]List of all members.
Detailed Description
An
ID3v2 custom text identification frame implementationx.
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.
Constructor & Destructor Documentation
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. |
Member Function Documentation
String TagLib::ID3v2::UserTextIdentificationFrame::description |
( |
|
) |
const |
|
|
Returns the description for this frame. |
StringList TagLib::ID3v2::UserTextIdentificationFrame::fieldList |
( |
|
) |
const |
|
|
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 & |
fields |
) |
|
|
|
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).
- Note:
- This will not change the text encoding of the frame even if the strings passed in are not of the same encoding. Please use setEncoding(s.type()) if you wish to change the encoding of the frame.
Reimplemented from TagLib::ID3v2::TextIdentificationFrame. |
void TagLib::ID3v2::UserTextIdentificationFrame::setText |
( |
const String & |
text |
) |
[virtual] |
|
virtual String TagLib::ID3v2::UserTextIdentificationFrame::toString |
( |
|
) |
const [virtual] |
|
Friends And Related Function Documentation
The documentation for this class was generated from the following file: