Akonadi::CollectionQuotaAttribute

Akonadi::CollectionQuotaAttribute Class Reference

#include <collectionquotaattribute.h>

Inheritance diagram for Akonadi::CollectionQuotaAttribute:

Public Member Functions

 CollectionQuotaAttribute ()
 
 CollectionQuotaAttribute (qint64 currentValue, qint64 maxValue)
 
 ~CollectionQuotaAttribute () override
 
Attributeclone () const override
 
qint64 currentValue () const
 
void deserialize (const QByteArray &data) override
 
qint64 maximumValue () const
 
QByteArray serialized () const override
 
void setCurrentValue (qint64 value)
 
void setMaximumValue (qint64 value)
 
QByteArray type () const override
 
- Public Member Functions inherited from Akonadi::Attribute
virtual ~Attribute ()
 

Additional Inherited Members

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

Detailed Description

Attribute that provides quota information for a collection.

This attribute class provides quota information (e.g. current fill value and maximum fill value) for an Akonadi collection.

Example:

using namespace Akonadi;
const Collection collection = collectionFetchJob->collections().at(0);
if ( collection.hasAttribute<CollectionQuotaAttribute>() ) {
qDebug() << "current value" << attribute->currentValue();
}
Author
Kevin Ottens ervin[email protected]@kde[email protected].org
Since
4.4

Definition at line 39 of file collectionquotaattribute.h.

Constructor & Destructor Documentation

CollectionQuotaAttribute::CollectionQuotaAttribute ( )

Creates a new collection quota attribute.

Definition at line 26 of file collectionquotaattribute.cpp.

CollectionQuotaAttribute::CollectionQuotaAttribute ( qint64  currentValue,
qint64  maxValue 
)

Creates a new collection quota attribute with initial values.

Parameters
currentValueThe current quota value in bytes.
maxValueThe maximum quota value in bytes.

Definition at line 31 of file collectionquotaattribute.cpp.

CollectionQuotaAttribute::~CollectionQuotaAttribute ( )
override

Destroys the collection quota attribute.

Definition at line 36 of file collectionquotaattribute.cpp.

Member Function Documentation

Akonadi::Attribute * CollectionQuotaAttribute::clone ( ) const
overridevirtual

Creates a copy of this attribute.

Implements Akonadi::Attribute.

Definition at line 67 of file collectionquotaattribute.cpp.

qint64 CollectionQuotaAttribute::currentValue ( ) const

Returns the current quota value in bytes.

Definition at line 51 of file collectionquotaattribute.cpp.

void CollectionQuotaAttribute::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 79 of file collectionquotaattribute.cpp.

qint64 CollectionQuotaAttribute::maximumValue ( ) const

Returns the maximum quota value in bytes.

Definition at line 56 of file collectionquotaattribute.cpp.

QByteArray CollectionQuotaAttribute::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 72 of file collectionquotaattribute.cpp.

void CollectionQuotaAttribute::setCurrentValue ( qint64  value)

Sets the current quota value for the collection.

Parameters
valueThe current quota value in bytes.

Definition at line 41 of file collectionquotaattribute.cpp.

void CollectionQuotaAttribute::setMaximumValue ( qint64  value)

Sets the maximum quota value for the collection.

Parameters
valueThe maximum quota value in bytes.

Definition at line 46 of file collectionquotaattribute.cpp.

QByteArray CollectionQuotaAttribute::type ( ) const
overridevirtual

Returns the type of the attribute.

Implements Akonadi::Attribute.

Definition at line 61 of file collectionquotaattribute.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Jul 8 2020 23:15:05 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.