|
|
An ID3v2 custom text identification frame implementationx. More...
#include <textidentificationframe.h>
Static Public Member Functions | |
| static UserTextIdentificationFrame * | find (Tag *tag, const String &description) |
 Static Public Member Functions inherited from TagLib::ID3v2::TextIdentificationFrame | |
| static TextIdentificationFrame * | createTIPLFrame (const PropertyMap &properties) |
| static TextIdentificationFrame * | createTMCLFrame (const PropertyMap &properties) |
| static const KeyConversionMap & | involvedPeopleMap () |
| Static Public Member Functions inherited from TagLib::ID3v2::Frame | |
| static Frame * | createTextualFrame (const String &key, const StringList &values) |
| static uint | headerSize () |
| static uint | headerSize (uint version) |
| static ByteVector | textDelimiter (String::Type t) |
| static uint | size () |
| static uint | size (uint version) |
Friends | |
| class | FrameFactory |
Additional Inherited Members | |
| Static Public Attributes inherited from TagLib::ID3v2::Frame | |
| static const String | instrumentPrefix |
| static const String | commentPrefix |
| static const String | lyricsPrefix |
| static const String | urlPrefix |
| Protected Member Functions inherited from TagLib::ID3v2::TextIdentificationFrame | |
| virtual void | parseFields (const ByteVector &data) |
| virtual ByteVector | renderFields () const |
| TextIdentificationFrame (const ByteVector &data, Header *h) | |
| Static Protected Member Functions inherited from TagLib::ID3v2::Frame | |
| static String::Type | checkEncoding (const StringList &fields, String::Type encoding) |
| static String::Type | checkEncoding (const StringList &fields, String::Type encoding, uint version) |
| static ByteVector | keyToFrameID (const String &) |
| static String | frameIDToKey (const ByteVector &) |
| static void | splitProperties (const PropertyMap &original, PropertyMap &singleFrameProperties, PropertyMap &tiplProperties, PropertyMap &tmclProperties) |
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
|
explicit |
Constructs an empty user defined text identification frame. For this to be a useful frame both a description and text must be set.
|
explicit |
Creates a frame based on data.
| TagLib::ID3v2::UserTextIdentificationFrame::UserTextIdentificationFrame | ( | const String & | description, |
| const StringList & | values, | ||
| String::Type | encoding = String::UTF8 |
||
| ) |
Creates a user defined text identification frame with the given description and values.
Member Function Documentation
| PropertyMap TagLib::ID3v2::UserTextIdentificationFrame::asProperties | ( | ) | const |
A UserTextIdentificationFrame is parsed into a PropertyMap as follows:
- the key is the frame's description, uppercased
- if the description contains '::', only the substring after that separator is considered as key (compatibility with exfalso)
- if the above rules don't yield a valid key (e.g. containing non-ASCII characters), the returned map will contain an entry "TXXX/<description>" in its unsupportedData() list.
- The values will be copies of the fieldList().
- If the description() appears as value in fieldList(), it will be omitted in the value list, in order to be compatible with TagLib which copies the description() into the fieldList().
Reimplemented from TagLib::ID3v2::TextIdentificationFrame.
| 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 |
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.
|
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.
- Note
- If the frame type supports multiple text encodings, this will not change the text encoding of the frame; the string will be converted to that frame's encoding. Please use the specific APIs of the frame types to set the encoding if that is desired.
Reimplemented from TagLib::ID3v2::TextIdentificationFrame.
| 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).
- 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.
|
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.
Friends And Related Function Documentation
|
friend |
The documentation for this class was generated from the following file: