Akonadi::SpecialCollectionAttribute

Search for usage in LXR

Akonadi::SpecialCollectionAttribute Class Reference

#include <specialcollectionattribute.h>

Inheritance diagram for Akonadi::SpecialCollectionAttribute:

Public Member Functions

 SpecialCollectionAttribute (const QByteArray &type=QByteArray())
 
 ~SpecialCollectionAttribute () override
 
SpecialCollectionAttributeclone () const override
 
QByteArray collectionType () const
 
void deserialize (const QByteArray &data) override
 
QByteArray serialized () const override
 
void setCollectionType (const QByteArray &type)
 
QByteArray type () const override
 
- Public Member Functions inherited from Akonadi::Attribute
virtual ~Attribute ()
 

Additional Inherited Members

- Public Types inherited from Akonadi::Attribute
using List = QList< Attribute * >
 
- Protected Member Functions inherited from Akonadi::Attribute
 Attribute (const Attribute &)=default
 

Detailed Description

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

All collections registered with SpecialCollections must have this attribute set.

Author
Constantin Berzan exit3[email protected][email protected][email protected]gmail[email protected].com
Since
4.4

Definition at line 28 of file specialcollectionattribute.h.

Constructor & Destructor Documentation

◆ SpecialCollectionAttribute()

SpecialCollectionAttribute::SpecialCollectionAttribute ( const QByteArray type = QByteArray())
explicit

Creates a new special collection attribute.

Definition at line 21 of file specialcollectionattribute.cpp.

◆ ~SpecialCollectionAttribute()

SpecialCollectionAttribute::~SpecialCollectionAttribute ( )
overridedefault

Destroys the special collection attribute.

Member Function Documentation

◆ clone()

SpecialCollectionAttribute * SpecialCollectionAttribute::clone ( ) const
overridevirtual

Creates a copy of this attribute.

Implements Akonadi::Attribute.

Definition at line 29 of file specialcollectionattribute.cpp.

◆ collectionType()

QByteArray SpecialCollectionAttribute::collectionType ( ) const

Returns the special collections type of the collection.

Definition at line 55 of file specialcollectionattribute.cpp.

◆ deserialize()

void SpecialCollectionAttribute::deserialize ( const QByteArray data)
overridevirtual

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

Parameters
dataThe encoded attribute data.

Implements Akonadi::Attribute.

Definition at line 45 of file specialcollectionattribute.cpp.

◆ serialized()

QByteArray SpecialCollectionAttribute::serialized ( ) const
overridevirtual

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 40 of file specialcollectionattribute.cpp.

◆ setCollectionType()

void SpecialCollectionAttribute::setCollectionType ( const QByteArray type)

Sets the special collections type of the collection.

Definition at line 50 of file specialcollectionattribute.cpp.

◆ type()

QByteArray SpecialCollectionAttribute::type ( ) const
overridevirtual

Returns the type of the attribute.

Implements Akonadi::Attribute.

Definition at line 34 of file specialcollectionattribute.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Tue Aug 16 2022 04:00:10 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.