TagLib 1.8.0 (TagLib::ID3v2::UrlLinkFrame Class Reference)

TagLib::ID3v2::UrlLinkFrame Class Reference

ID3v2 URL frame. More...

#include <urllinkframe.h>

Inheritance diagram for TagLib::ID3v2::UrlLinkFrame:
Collaboration diagram for TagLib::ID3v2::UrlLinkFrame:

List of all members.

Public Member Functions

 UrlLinkFrame (const ByteVector &data)
virtual ~UrlLinkFrame ()
virtual String url () const
virtual void setUrl (const String &s)
virtual void setText (const String &s)
virtual String toString () const
PropertyMap asProperties () const

Protected Member Functions

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

Friends

class FrameFactory

Detailed Description

ID3v2 URL frame.

An implementation of ID3v2 URL link frames.


Constructor & Destructor Documentation

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

Destroys this UrlLinkFrame instance.

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

The constructor used by the FrameFactory.


Member Function Documentation

Parses the contents of this frame as PropertyMap. If that fails, the returend PropertyMap will be empty, and its unsupportedData() will contain this frame's ID. BIC: Will be a virtual function in future releases.

Reimplemented from TagLib::ID3v2::Frame.

Reimplemented in TagLib::ID3v2::UserUrlLinkFrame.

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

Reimplemented in TagLib::ID3v2::UserUrlLinkFrame.

virtual ByteVector TagLib::ID3v2::UrlLinkFrame::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.

Reimplemented in TagLib::ID3v2::UserUrlLinkFrame.

virtual void TagLib::ID3v2::UrlLinkFrame::setText ( const String text) [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::Frame.

virtual void TagLib::ID3v2::UrlLinkFrame::setUrl ( const String s) [virtual]

Sets the URL to s.

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

Implements TagLib::ID3v2::Frame.

Reimplemented in TagLib::ID3v2::UserUrlLinkFrame.

virtual String TagLib::ID3v2::UrlLinkFrame::url ( ) const [virtual]

Returns the URL.


Friends And Related Function Documentation

friend class FrameFactory [friend]

Reimplemented from TagLib::ID3v2::Frame.

Reimplemented in TagLib::ID3v2::UserUrlLinkFrame.


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