Akonadi::CollectionQuotaAttribute
#include <collectionquotaattribute.h>
Public Member Functions | |
CollectionQuotaAttribute () | |
CollectionQuotaAttribute (qint64 currentValue, qint64 maxValue) | |
~CollectionQuotaAttribute () override | |
Attribute * | clone () 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 | |
using | List = QList<Attribute *> |
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:
- Since
- 4.4
Definition at line 41 of file collectionquotaattribute.h.
Constructor & Destructor Documentation
◆ CollectionQuotaAttribute() [1/2]
|
explicit |
Creates a new collection quota attribute.
Definition at line 20 of file collectionquotaattribute.cpp.
◆ CollectionQuotaAttribute() [2/2]
CollectionQuotaAttribute::CollectionQuotaAttribute | ( | qint64 | currentValue, |
qint64 | maxValue ) |
Creates a new collection quota attribute with initial values.
- Parameters
-
currentValue The current quota value in bytes. maxValue The maximum quota value in bytes.
Definition at line 25 of file collectionquotaattribute.cpp.
◆ ~CollectionQuotaAttribute()
|
overridedefault |
Destroys the collection quota attribute.
Member Function Documentation
◆ clone()
|
overridevirtual |
Creates a copy of this attribute.
Implements Akonadi::Attribute.
Definition at line 59 of file collectionquotaattribute.cpp.
◆ currentValue()
|
nodiscard |
Returns the current quota value in bytes.
Definition at line 44 of file collectionquotaattribute.cpp.
◆ deserialize()
|
overridevirtual |
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 69 of file collectionquotaattribute.cpp.
◆ maximumValue()
|
nodiscard |
Returns the maximum quota value in bytes.
Definition at line 49 of file collectionquotaattribute.cpp.
◆ serialized()
|
nodiscardoverridevirtual |
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 64 of file collectionquotaattribute.cpp.
◆ setCurrentValue()
void CollectionQuotaAttribute::setCurrentValue | ( | qint64 | value | ) |
Sets the current quota value
for the collection.
- Parameters
-
value The current quota value in bytes.
Definition at line 34 of file collectionquotaattribute.cpp.
◆ setMaximumValue()
void CollectionQuotaAttribute::setMaximumValue | ( | qint64 | value | ) |
Sets the maximum quota value
for the collection.
- Parameters
-
value The maximum quota value in bytes.
Definition at line 39 of file collectionquotaattribute.cpp.
◆ type()
|
overridevirtual |
Returns the type of the attribute.
Implements Akonadi::Attribute.
Definition at line 54 of file collectionquotaattribute.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:01:01 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.