Contents

Akonadi::EntityHiddenAttribute Class

class Akonadi::EntityHiddenAttribute

An Attribute that marks that an entity should be hidden in the UI. More...

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

Public Functions

EntityHiddenAttribute()
virtual ~EntityHiddenAttribute() override

Reimplemented Public Functions

virtual Akonadi::EntityHiddenAttribute *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:

 using namespace Akonadi;

 ...
 // hide a collection by setting the hidden attribute
 Collection collection = collectionFetchJob->collections().at(0);
 collection.attribute<EntityHiddenAttribute>( Collection::AddIfMissing );
 new CollectionModifyJob( collection, this ); // save back to storage

 // check if the collection is hidden
 if ( collection.hasAttribute<EntityHiddenAttribute>() )
   qDebug() << "collection is hidden";
 else
   qDebug() << "collection is visible";

Author: Szymon Stefanek <s.stefanek@gmail.com>

See also Akonadi::Attribute.

Member Function Documentation

[explicit] EntityHiddenAttribute::EntityHiddenAttribute()

Creates a new entity hidden attribute.

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

Destroys the entity hidden attribute.

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

Reimplements: Attribute::clone() const.

Reimplemented from Attribute

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

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

Reimplemented from Attribute

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

Reimplements: Attribute::serialized() const.

Reimplemented from Attribute

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

Reimplements: Attribute::type() const.

Reimplemented from Attribute