Akonadi::EntityHiddenAttribute

Akonadi::EntityHiddenAttribute Class Reference

#include <entityhiddenattribute.h>

Inheritance diagram for Akonadi::EntityHiddenAttribute:

Public Member Functions

 EntityHiddenAttribute ()
 
 ~EntityHiddenAttribute () override
 
EntityHiddenAttributeclone () 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
typedef QList< Attribute * > List
 
- 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);
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[email protected]fane[email protected][email protected][email protected]il.c[email protected]om
See also
Akonadi::Attribute
Since
4.4

Definition at line 49 of file entityhiddenattribute.h.

Constructor & Destructor Documentation

EntityHiddenAttribute::EntityHiddenAttribute ( )

Creates a new entity hidden attribute.

Definition at line 15 of file entityhiddenattribute.cpp.

EntityHiddenAttribute::~EntityHiddenAttribute ( )
override

Destroys the entity hidden attribute.

Definition at line 20 of file entityhiddenattribute.cpp.

Member Function Documentation

EntityHiddenAttribute * EntityHiddenAttribute::clone ( ) const
overridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 30 of file entityhiddenattribute.cpp.

void EntityHiddenAttribute::deserialize ( const QByteArray data)
overridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 40 of file entityhiddenattribute.cpp.

QByteArray EntityHiddenAttribute::serialized ( ) const
overridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 35 of file entityhiddenattribute.cpp.

QByteArray Akonadi::EntityHiddenAttribute::type ( ) const
overridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 24 of file entityhiddenattribute.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 Mon Aug 3 2020 23:15:45 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.