Akonadi::CollectionRightsAttribute Class Reference

Attribute that stores the rights of a collection. More...

#include <collectionrightsattribute.h>

Inheritance diagram for Akonadi::CollectionRightsAttribute:

[legend]

List of all members.

Public Member Functions
virtual CollectionRightsAttribute *	clone () const
	CollectionRightsAttribute ()
virtual void	deserialize (const QByteArray &)
Collection::Rights	rights () const
virtual QByteArray	serialized () const
void	setRights (Collection::Rights rights)
virtual QByteArray	type () const
	~CollectionRightsAttribute ()

---

Detailed Description

Attribute that stores the rights of a collection.

Every collection can have rights set which describes whether the collection is readable or writable. That information is stored in this custom attribute.

Note:

You shouldn't use this class directly but the convenience methods Collection::rights() and Collection::setRights() instead.

Author:

Tobias Koenig <tokoe@kde.org>

Definition at line 42 of file collectionrightsattribute.h.

---

Constructor & Destructor Documentation

CollectionRightsAttribute::CollectionRightsAttribute

(

)

Creates a new collection rights attribute.

Definition at line 81 of file collectionrightsattribute.cpp.

CollectionRightsAttribute::~CollectionRightsAttribute

(

)

Destroys the collection rights attribute.

Definition at line 86 of file collectionrightsattribute.cpp.

---

Member Function Documentation

CollectionRightsAttribute * CollectionRightsAttribute::clone

(

)

const [virtual]

Creates a copy of this attribute.

Implements Akonadi::Attribute.

Definition at line 101 of file collectionrightsattribute.cpp.

void CollectionRightsAttribute::deserialize

(

const QByteArray &

data

)

[virtual]

Sets the data of this attribute, using the same encoding as returned by toByteArray().

Parameters:

data

The encoded attribute data.

Implements Akonadi::Attribute.

Definition at line 119 of file collectionrightsattribute.cpp.

Collection::Rights CollectionRightsAttribute::rights

(

)

const

Returns the rights of the collection.

Definition at line 96 of file collectionrightsattribute.cpp.

QByteArray CollectionRightsAttribute::serialized

(

)

const [virtual]

Returns a QByteArray representation of the attribute which will be storaged.

This can be raw binary data, no encoding needs to be applied.

Implements Akonadi::Attribute.

Definition at line 114 of file collectionrightsattribute.cpp.

void CollectionRightsAttribute::setRights

(

Collection::Rights

rights

)

Sets the rights of the collection.

Definition at line 91 of file collectionrightsattribute.cpp.

QByteArray CollectionRightsAttribute::type

(

)

const [virtual]

Returns the type of the attribute.

Implements Akonadi::Attribute.

Definition at line 109 of file collectionrightsattribute.cpp.

---

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

• collectionrightsattribute.h
• collectionrightsattribute.cpp