TagLib 1.6.1 (TagLib: TagLib::ID3v2::CommentsFrame Class Reference)

TagLib::ID3v2::CommentsFrame Class Reference

An implementation of ID3v2 comments. More...

#include <commentsframe.h>

Inheritance diagram for TagLib::ID3v2::CommentsFrame:
Collaboration diagram for TagLib::ID3v2::CommentsFrame:

List of all members.

Public Member Functions

 CommentsFrame (String::Type encoding=String::Latin1)
 CommentsFrame (const ByteVector &data)
virtual ~CommentsFrame ()
virtual String toString () const
ByteVector language () const
String description () const
String text () const
void setLanguage (const ByteVector &languageCode)
void setDescription (const String &s)
virtual void setText (const String &s)
String::Type textEncoding () const
void setTextEncoding (String::Type encoding)

Static Public Member Functions

static CommentsFramefindByDescription (const Tag *tag, const String &d)

Protected Member Functions

virtual void parseFields (const ByteVector &data)
virtual ByteVector renderFields () const

Friends

class FrameFactory


Detailed Description

An implementation of ID3v2 comments.

This implements the ID3v2 comment format. An ID3v2 comment concists of a language encoding, a description and a single text field.


Constructor & Destructor Documentation

TagLib::ID3v2::CommentsFrame::CommentsFrame ( String::Type  encoding = String::Latin1  )  [explicit]

Construct an empty comment frame that will use the text encoding encoding.

TagLib::ID3v2::CommentsFrame::CommentsFrame ( const ByteVector data  )  [explicit]

Construct a comment based on the data in data.

virtual TagLib::ID3v2::CommentsFrame::~CommentsFrame (  )  [virtual]

Destroys this CommentFrame instance.


Member Function Documentation

String TagLib::ID3v2::CommentsFrame::description (  )  const

Returns the description of this comment.

Note:
Most taggers simply ignore this value.
See also:
setDescription()

static CommentsFrame* TagLib::ID3v2::CommentsFrame::findByDescription ( const Tag tag,
const String d 
) [static]

Comments each have a unique description. This searches for a comment frame with the decription d and returns a pointer to it. If no frame is found that matches the given description null is returned.

See also:
description()

ByteVector TagLib::ID3v2::CommentsFrame::language (  )  const

Returns the language encoding as a 3 byte encoding as specified by ISO-639-2.

Note:
Most taggers simply ignore this value.
See also:
setLanguage()

virtual void TagLib::ID3v2::CommentsFrame::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::CommentsFrame::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.

void TagLib::ID3v2::CommentsFrame::setDescription ( const String s  ) 

Sets the description of the comment to s.

See also:
decription()

void TagLib::ID3v2::CommentsFrame::setLanguage ( const ByteVector languageCode  ) 

Set the language using the 3 byte language code from ISO-639-2 to languageCode.

See also:
language()

virtual void TagLib::ID3v2::CommentsFrame::setText ( const String s  )  [virtual]

Sets the text portion of the comment to s.

See also:
text()

Reimplemented from TagLib::ID3v2::Frame.

void TagLib::ID3v2::CommentsFrame::setTextEncoding ( String::Type  encoding  ) 

Sets the text encoding to be used when rendering this frame to encoding.

See also:
textEncoding()

render()

String TagLib::ID3v2::CommentsFrame::text (  )  const

Returns the text of this comment.

See also:
setText()

String::Type TagLib::ID3v2::CommentsFrame::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.

See also:
setTextEncoding()

render()

virtual String TagLib::ID3v2::CommentsFrame::toString (  )  const [virtual]

Returns the text of this comment.

See also:
text()

Implements TagLib::ID3v2::Frame.


Friends And Related Function Documentation

friend class FrameFactory [friend]

Reimplemented from TagLib::ID3v2::Frame.


The documentation for this class was generated from the following file: