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

TagLib::ID3v2::UserUrlLinkFrame Class Reference

ID3v2 User defined URL frame. More...

#include <urllinkframe.h>

Inheritance diagram for TagLib::ID3v2::UserUrlLinkFrame:
Collaboration diagram for TagLib::ID3v2::UserUrlLinkFrame:

List of all members.

Public Member Functions

 UserUrlLinkFrame (String::Type encoding=String::Latin1)
 UserUrlLinkFrame (const ByteVector &data)
virtual ~UserUrlLinkFrame ()
virtual String toString () const
String::Type textEncoding () const
void setTextEncoding (String::Type encoding)
String description () const
void setDescription (const String &s)

Protected Member Functions

virtual void parseFields (const ByteVector &data)
virtual ByteVector renderFields () const
 UserUrlLinkFrame (const ByteVector &data, Header *h)

Friends

class FrameFactory


Detailed Description

ID3v2 User defined URL frame.

This is a specialization of URL link frames that allows for user defined entries. Each entry has a description in addition to the normal list of fields that a URL link frame has.

This description identifies the frame and must be unique.


Constructor & Destructor Documentation

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

Constructs an empty user defined URL link frame. For this to be a useful frame both a description and text must be set.

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

This is a dual purpose constructor. data can either be binary data that should be parsed or (at a minimum) the frame ID.

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

Destroys this UserUrlLinkFrame instance.

TagLib::ID3v2::UserUrlLinkFrame::UserUrlLinkFrame ( const ByteVector data,
Header h 
) [protected]

The constructor used by the FrameFactory.


Member Function Documentation

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

Returns the description for this frame.

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

Reimplemented from TagLib::ID3v2::UrlLinkFrame.

virtual ByteVector TagLib::ID3v2::UserUrlLinkFrame::renderFields (  )  const [protected, virtual]

Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.

Reimplemented from TagLib::ID3v2::UrlLinkFrame.

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

Sets the description of the frame to s. s must be unique.

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

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

See also:
textEncoding()

render()

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


Friends And Related Function Documentation

friend class FrameFactory [friend]

Reimplemented from TagLib::ID3v2::UrlLinkFrame.


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