TagLib API Documentation

TagLib::ID3v2::CommentsFrame Class Reference

An implementation of ID3v2 comments. More...

#include <commentsframe.h>

Inheritance diagram for TagLib::ID3v2::CommentsFrame:

TagLib::ID3v2::Frame 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)

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.

Definition at line 38 of file commentsframe.h.


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

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

Returns the text of this comment.

See also:
text()

Implements TagLib::ID3v2::Frame.

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()

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

Returns the description of this comment.

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

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

Returns the text of this comment.

See also:
setText()

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()

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

Sets the description of the comment to s.

See also:
decription()

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.

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()

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()

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.


Friends And Related Function Documentation

friend class FrameFactory [friend]
 

Reimplemented from TagLib::ID3v2::Frame.

Definition at line 40 of file commentsframe.h.


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for TagLib Version 1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Jan 22 05:44:22 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2003