Akonadi::EntityHiddenAttribute Class Reference

#include <entityhiddenattribute.h>

Inheritance diagram for Akonadi::EntityHiddenAttribute:

Public Member Functions
	EntityHiddenAttribute ()
	~EntityHiddenAttribute () override
EntityHiddenAttribute *	clone () const override
void	deserialize (const QByteArray &data) override
QByteArray	serialized () const override
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 marks that an entity should be hidden in the UI.

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.ste.nosp@m.fane.nosp@m.k@gma.nosp@m.il.c.nosp@m.om

See also

Akonadi::Attribute

Since

4.4

Definition at line 51 of file entityhiddenattribute.h.

Constructor & Destructor Documentation

EntityHiddenAttribute()

EntityHiddenAttribute::EntityHiddenAttribute ( )

explicitdefault

Creates a new entity hidden attribute.

~EntityHiddenAttribute()

EntityHiddenAttribute::~EntityHiddenAttribute ( )

overridedefault

Destroys the entity hidden attribute.

Member Function Documentation

clone()

EntityHiddenAttribute * EntityHiddenAttribute::clone ( ) const

overridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 28 of file entityhiddenattribute.cpp.

deserialize()

void EntityHiddenAttribute::deserialize ( const QByteArray & data )

overridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 38 of file entityhiddenattribute.cpp.

serialized()

QByteArray EntityHiddenAttribute::serialized ( ) const

nodiscardoverridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 33 of file entityhiddenattribute.cpp.

type()

QByteArray Akonadi::EntityHiddenAttribute::type ( ) const

nodiscardoverridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 23 of file entityhiddenattribute.cpp.

---

The documentation for this class was generated from the following files:

• entityhiddenattribute.h
• entityhiddenattribute.cpp