mirror of
https://github.com/taglib/taglib.git
synced 2025-06-04 01:28:21 -04:00
c538ac3912
git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@340248 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
143 lines
3.7 KiB
C++
143 lines
3.7 KiB
C++
/***************************************************************************
|
|
copyright : (C) 2004 by Allan Sandfeld Jensen
|
|
email : kde@carewolf.org
|
|
***************************************************************************/
|
|
|
|
/***************************************************************************
|
|
* This library is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU Lesser General Public License version *
|
|
* 2.1 as published by the Free Software Foundation. *
|
|
* *
|
|
* This library is distributed in the hope that it will be useful, but *
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
|
|
* Lesser General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Lesser General Public *
|
|
* License along with this library; if not, write to the Free Software *
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
|
|
* USA *
|
|
***************************************************************************/
|
|
|
|
#ifndef TAGLIB_APEITEM_H
|
|
#define TAGLIB_APEITEM_H
|
|
|
|
#include <tbytevector.h>
|
|
#include <tstring.h>
|
|
#include <tstringlist.h>
|
|
|
|
namespace TagLib {
|
|
|
|
namespace APE {
|
|
|
|
//! An implementation of APE-items
|
|
|
|
/*!
|
|
* This class provides the features of items in the APEv2 standard.
|
|
*/
|
|
struct Item
|
|
{
|
|
/*!
|
|
* Enum of types an Item can have. The value of 3 is reserved.
|
|
*/
|
|
enum ItemTypes {
|
|
//! item contains text information coded in UTF-8
|
|
Text = 0,
|
|
//! item contains binary information
|
|
Binary = 1,
|
|
//! item is a locator of external stored information
|
|
Locator = 2
|
|
};
|
|
/*!
|
|
* Constructs an empty item.
|
|
*/
|
|
Item();
|
|
|
|
/*!
|
|
* Constructs an item with \a key and \a value.
|
|
*/
|
|
Item(const String& key, const String& value);
|
|
|
|
/*!
|
|
* Constructs an item with \a key and \a values.
|
|
*/
|
|
Item(const String& key, const StringList& values);
|
|
|
|
Item(const Item&);
|
|
Item& operator=(const Item&);
|
|
|
|
/*!
|
|
* Returns the key
|
|
*/
|
|
String key() const;
|
|
|
|
/*!
|
|
* Returns the binary value
|
|
*/
|
|
ByteVector value() const;
|
|
|
|
/*!
|
|
* Returns the size of the full item
|
|
*/
|
|
int size() const;
|
|
|
|
/*!
|
|
* Returns the value as a single string. In case of multiple strings,
|
|
* the first is returned.
|
|
*/
|
|
String toString() const;
|
|
|
|
/*!
|
|
* Returns the value as a string list.
|
|
*/
|
|
StringList toStringList() const;
|
|
|
|
/*!
|
|
* Render the item to a ByteVector
|
|
*/
|
|
ByteVector render();
|
|
|
|
/*!
|
|
* Parse the item from the ByteVector \a data
|
|
*/
|
|
void parse(const ByteVector& data);
|
|
|
|
/*!
|
|
* Set the item to read-only
|
|
*/
|
|
void setReadOnly(bool);
|
|
|
|
/*!
|
|
* Returns if the item is read-only
|
|
*/
|
|
bool isReadOnly() const;
|
|
|
|
/*!
|
|
* Sets the type of the item to \a type.
|
|
*
|
|
* \see ItemTypes
|
|
*/
|
|
void setType(ItemTypes type);
|
|
|
|
/*!
|
|
* Returns the type of the item.
|
|
*/
|
|
ItemTypes type() const;
|
|
|
|
/*!
|
|
* Returns if the item has any real content.
|
|
*/
|
|
bool isEmpty() const;
|
|
|
|
private:
|
|
class ItemPrivate;
|
|
ItemPrivate *d;
|
|
};
|
|
}
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|