Akonadi::SpecialCollectionAttribute Class

class Akonadi::SpecialCollectionAttribute

An Attribute that stores the special collection type of a collection. More...

Header: #include <Akonadi/SpecialCollectionAttribute>
CMake: find_package(KPim6 REQUIRED COMPONENTS AkonadiCore)
target_link_libraries(mytarget PRIVATE KPim6::AkonadiCore)
Inherits: Akonadi::Attribute

Public Functions

SpecialCollectionAttribute(const QByteArray &type = QByteArray())
virtual ~SpecialCollectionAttribute() override
QByteArray collectionType() const
void setCollectionType(const QByteArray &type)

Reimplemented Public Functions

virtual void deserialize(const QByteArray &data) override
virtual QByteArray serialized() const override
virtual QByteArray type() const override

Detailed Description

All collections registered with SpecialCollections must have this attribute set.

Author: Constantin Berzan <exit3219@gmail.com>

Member Function Documentation

[explicit] SpecialCollectionAttribute::SpecialCollectionAttribute(const QByteArray &type = QByteArray())

Creates a new special collection attribute.

[override virtual noexcept] SpecialCollectionAttribute::~SpecialCollectionAttribute()

Destroys the special collection attribute.

QByteArray SpecialCollectionAttribute::collectionType() const

Returns the special collections type of the collection.

See also setCollectionType().

[override virtual] void SpecialCollectionAttribute::deserialize(const QByteArray &data)

Reimplements: Attribute::deserialize(const QByteArray &data).

[override virtual] QByteArray SpecialCollectionAttribute::serialized() const

Reimplements: Attribute::serialized() const.

void SpecialCollectionAttribute::setCollectionType(const QByteArray &type)

Sets the special collections type of the collection.

See also collectionType().

[override virtual] QByteArray SpecialCollectionAttribute::type() const

Reimplements: Attribute::type() const.