Tag Class Reference

#include <wmatag.h>

Collaboration diagram for Tag:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual String album () const
virtual String artist () const
const AttributeMapattributeMap () const
virtual String comment () const
virtual String copyright () const
virtual String genre () const
virtual bool isEmpty () const
virtual String rating () const
void removeItem (const ByteVector &key)
virtual void setAlbum (const String &s)
virtual void setArtist (const String &s)
void setAttribute (const ByteVector &key, const Attribute &attribute)
void setAttribute (const ByteVector &key, const String &value)
virtual void setComment (const String &s)
virtual void setCopyright (const String &s)
virtual void setGenre (const String &s)
virtual void setRating (const String &s)
virtual void setTitle (const String &s)
virtual void setTrack (uint i)
virtual void setYear (uint i)
 Tag ()
virtual String title () const
virtual uint track () const
virtual uint year () const
virtual ~Tag ()

Static Public Member Functions

static void duplicate (const Tag *source, Tag *target, bool overwrite=true)

Private Attributes

TagPrivated

Friends

class File

Classes

class  TagPrivate

Detailed Description

Definition at line 36 of file wmatag.h.


Constructor & Destructor Documentation

Tag (  ) 

virtual ~Tag (  )  [virtual]


Member Function Documentation

virtual String album (  )  const [virtual]

Returns the album name; if no album name is present in the tag String::null will be returned.

virtual String artist (  )  const [virtual]

Returns the artist name.

const AttributeMap& attributeMap (  )  const

Returns a reference to the item list map. This is an ItemListMap of all of the items in the tag.

This is the most powerfull structure for accessing the items of the tag.

Warning:
You should not modify this data structure directly, instead use setItem() and removeItem().

virtual String comment (  )  const [virtual]

Returns the track comment.

virtual String copyright (  )  const [virtual]

Returns the genre name; if no genre is present in the tag String::null will be returned.

static void duplicate ( const Tag source,
Tag target,
bool  overwrite = true 
) [static]

Copies the generic data from one tag to another.

If overwrite is true then the values will be unconditionally copied. If false only empty values will be overwritten.

virtual String genre (  )  const [virtual]

Returns the genre name; if no genre is present in the tag String::null will be returned.

virtual bool isEmpty (  )  const [virtual]

Returns true if the tag does not contain any data. This should be reimplemented in subclasses that provide more than the basic tagging abilities in this class.

virtual String rating (  )  const [virtual]

Returns the rating.

void removeItem ( const ByteVector &  key  ) 

Removes the key attribute from the tag

virtual void setAlbum ( const String &  s  )  [virtual]

Sets the album to s. If s is String::null then this value will be cleared.

virtual void setArtist ( const String &  s  )  [virtual]

Sets the artist to s.

void setAttribute ( const ByteVector &  key,
const Attribute attribute 
)

Sets the key attribute to the value of attribute. If an attribute with the key is already present, it will be replaced.

void setAttribute ( const ByteVector &  key,
const String &  value 
)

virtual void setComment ( const String &  s  )  [virtual]

Sets the comment to s.

virtual void setCopyright ( const String &  s  )  [virtual]

Sets the copyright to s.

virtual void setGenre ( const String &  s  )  [virtual]

Sets the genre to s.

virtual void setRating ( const String &  s  )  [virtual]

Sets the rating to s.

virtual void setTitle ( const String &  s  )  [virtual]

Sets the title to s.

virtual void setTrack ( uint  i  )  [virtual]

Sets the track to i. If s is 0 then this value will be cleared.

virtual void setYear ( uint  i  )  [virtual]

Sets the year to i. If s is 0 then this value will be cleared.

virtual String title (  )  const [virtual]

Returns the track name.

virtual uint track (  )  const [virtual]

Returns the track number; if there is no track number set, this will return 0.

virtual uint year (  )  const [virtual]

Returns the year; if there is no year set, this will return 0.


Friends And Related Function Documentation

friend class File [friend]

Definition at line 38 of file wmatag.h.


Member Data Documentation

TagPrivate* d [private]

Definition at line 182 of file wmatag.h.


The documentation for this class was generated from the following file:
Generated on Mon Aug 6 21:24:57 2007 for plai by  doxygen 1.5.1