Akonadi::EntityDeletedAttribute Class

class Akonadi::EntityDeletedAttribute

An Attribute that marks that an entity was marked as deleted. More...

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

Public Functions

EntityDeletedAttribute()
virtual ~EntityDeletedAttribute() override
Akonadi::Collection restoreCollection() const
QString restoreResource() const
void setRestoreCollection(const Akonadi::Collection &col)

Reimplemented Public Functions

virtual Akonadi::EntityDeletedAttribute *clone() const override
virtual void deserialize(const QByteArray &data) override
virtual QByteArray serialized() const override
virtual QByteArray type() const override

Detailed Description

This class represents the attribute of all hidden items. The hidden items shouldn't be displayed in UI applications (unless in some kind of "debug" mode).

Example:


Author: Christian Mollekopf <chrigi_1@fastmail.fm>

See also Akonadi::Attribute.

Member Function Documentation

[explicit] EntityDeletedAttribute::EntityDeletedAttribute()

Creates a new entity deleted attribute.

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

Destroys the entity deleted attribute.

[override virtual] Akonadi::EntityDeletedAttribute *EntityDeletedAttribute::clone() const

Reimplements: Attribute::clone() const.

Reimplemented from Attribute

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

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

Reimplemented from Attribute

Akonadi::Collection EntityDeletedAttribute::restoreCollection() const

Returns the original collection of an item that has been moved to trash using a TrashJob

See also setRestoreCollection().

QString EntityDeletedAttribute::restoreResource() const

Returns the resource of the restoreCollection

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

Reimplements: Attribute::serialized() const.

Reimplemented from Attribute

void EntityDeletedAttribute::setRestoreCollection(const Akonadi::Collection &col)

Sets the collection used to restore items which have been moved to trash using a TrashJob If the Resource is set on the collection, the resource root will be used as fallback during the restore operation.

See also restoreCollection().

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

Reimplements: Attribute::type() const.

Reimplemented from Attribute