Akonadi::Tag Class Reference

#include <tag.h>

Inheritance diagram for Akonadi::Tag:

Public Types
typedef qint64	Id
typedef QList< Tag >	List
Public Types inherited from Akonadi::AttributeEntity
enum	CreateOption { AddIfMissing }

Public Member Functions
	Tag (Id id)
	Tag (const QString &name)
	Tag (const Tag &other)
QByteArray	gid () const
Id	id () const
bool	isImmutable () const
bool	isValid () const
QString	name () const
Tag &	operator= (const Tag &)
AttributeEntity &	operator= (const AttributeEntity &)
bool	operator== (const Tag &) const
Tag	parent () const
QByteArray	remoteId () const
void	setGid (const QByteArray &gid) const
void	setId (Id identifier)
void	setName (const QString &name)
void	setParent (const Tag &parent)
void	setRemoteId (const QByteArray &remoteId) const
void	setType (const QByteArray &type) const
QByteArray	type () const
KUrl	url () const
Public Member Functions inherited from Akonadi::AttributeEntity
	AttributeEntity (const AttributeEntity &other)
void	addAttribute (Attribute *attribute)
Attribute *	attribute (const QByteArray &name) const
template<typename T >
T *	attribute (CreateOption option)
template<typename T >
T *	attribute () const
Attribute::List	attributes () const
void	clearAttributes ()
bool	hasAttribute (const QByteArray &name) const
template<typename T >
bool	hasAttribute () const
void	removeAttribute (const QByteArray &name)
template<typename T >
void	removeAttribute ()

Static Public Member Functions
static Tag	fromUrl (const KUrl &url)

Static Public Attributes
static const char *	PLAIN = "PLAIN"

Detailed Description

An Akonadi Tag.

Definition at line 43 of file tag.h.

Constructor & Destructor Documentation

Tag::Tag ( const QString &  name )

explicit

Creates a PLAIN tag.

Definition at line 56 of file tag.cpp.

Member Function Documentation

Tag::Id Tag::id

(

)

const

Returns the unique identifier of the tag.

Definition at line 131 of file tag.cpp.

bool Tag::isImmutable

(

)

const

Returns true if the tag is immutable (cannot be modified after creation).

Note that the immutability does not affect the attributes.

Definition at line 201 of file tag.cpp.

void Tag::setId

(

Tag::Id

identifier

)

Sets the unique identifier of the tag.

Definition at line 126 of file tag.cpp.

KUrl Tag::url

(

)

const

Returns the url of the tag.

Definition at line 118 of file tag.cpp.

Member Data Documentation

const char * Akonadi::Tag::PLAIN = "PLAIN"

static

The PLAIN type has the following properties:

• gid == displayName
• immutable
• no hierarchy (no parent)

PLAIN tags are general purpose tags that are easy to map by backends.

Definition at line 57 of file tag.h.

---

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

• tag.h
• tag.cpp