TagLib::APE::Item Class Reference

An implementation of APE-items. More...

#include <apeitem.h>

List of all members.

Public Types

enum  ItemTypes { Text = 0, Binary = 1, Locator = 2 }

Public Member Functions

 Item ()
 Item (const String &key, const String &value)
 Item (const String &key, const StringList &values)
 Item (const String &key, const ByteVector &value, bool binary)
 Item (const Item &item)
virtual ~Item ()
Itemoperator= (const Item &item)
void swap (Item &item)
String key () const
ByteVector binaryData () const
void setBinaryData (const ByteVector &value)
void setKey (const String &key)
void setValue (const String &value)
void setValues (const StringList &values)
void appendValue (const String &value)
void appendValues (const StringList &values)
int size () const
String toString () const
StringList values () const
ByteVector render () const
void parse (const ByteVector &data)
void setReadOnly (bool readOnly)
bool isReadOnly () const
void setType (ItemTypes type)
ItemTypes type () const
bool isEmpty () const

Detailed Description

An implementation of APE-items.

This class provides the features of items in the APEv2 standard.


Member Enumeration Documentation

Enum of types an Item can have. The value of 3 is reserved.

Enumerator:
Text 

Item contains text information coded in UTF-8.

Binary 

Item contains binary information.

Locator 

Item is a locator of external stored information.


Constructor & Destructor Documentation

Constructs an empty item.

TagLib::APE::Item::Item ( const String key,
const String value 
)

Constructs a text item with key and value.

TagLib::APE::Item::Item ( const String key,
const StringList values 
)

Constructs a text item with key and values.

TagLib::APE::Item::Item ( const String key,
const ByteVector value,
bool  binary 
)

Constructs an item with key and value. If binary is true a Binary item will be created, otherwise value will be interpreted as text

TagLib::APE::Item::Item ( const Item item)

Construct an item as a copy of item.

virtual TagLib::APE::Item::~Item ( ) [virtual]

Destroys the item.


Member Function Documentation

void TagLib::APE::Item::appendValue ( const String value)

Appends value to create (or extend) the current list of text values.

See also:
toString()
void TagLib::APE::Item::appendValues ( const StringList values)

Appends values to extend the current list of text values.

See also:
toStringList()

Returns the binary value. If the item type is not Binary, always returns an empty ByteVector.

Returns if the item has any real content.

Return true if the item is read-only.

Returns the key.

Item& TagLib::APE::Item::operator= ( const Item item)

Copies the contents of item into this item.

void TagLib::APE::Item::parse ( const ByteVector data)

Parse the item from the ByteVector data.

Render the item to a ByteVector.

Set the binary value to value The item's type will also be set to Binary

void TagLib::APE::Item::setKey ( const String key)

Sets the key for the item to key.

void TagLib::APE::Item::setReadOnly ( bool  readOnly)

Set the item to read-only.

Sets the type of the item to type.

See also:
ItemTypes
void TagLib::APE::Item::setValue ( const String value)

Sets the text value of the item to value and clears any previous contents.

See also:
toString()
void TagLib::APE::Item::setValues ( const StringList values)

Sets the text value of the item to the list of values in value and clears any previous contents.

See also:
toStringList()
int TagLib::APE::Item::size ( ) const

Returns the size of the full item.

void TagLib::APE::Item::swap ( Item item)

Exchanges the content of this item by the content of item.

Returns the value as a single string. In case of multiple strings, the first is returned. If the data type is not Text, always returns an empty String.

Returns the type of the item.

Returns the list of text values. If the data type is not Text, always returns an empty StringList.


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