Akonadi::EntityHiddenAttribute Class Reference

#include <entityhiddenattribute.h>

Inheritance diagram for Akonadi::EntityHiddenAttribute:

Public Member Functions
	EntityHiddenAttribute ()
	~EntityHiddenAttribute ()
EntityHiddenAttribute *	clone () const
void	deserialize (const QByteArray &data)
QByteArray	serialized () const
QByteArray	type () const
Public Member Functions inherited from Akonadi::Attribute
virtual	~Attribute ()

Additional Inherited Members
Public Types inherited from Akonadi::Attribute
typedef QList< Attribute * >	List

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().first();
collection.attribute<EntityHiddenAttribute>( Entity::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 60 of file entityhiddenattribute.h.

Constructor & Destructor Documentation

EntityHiddenAttribute::EntityHiddenAttribute

(

)

Creates a new entity hidden attribute.

Definition at line 28 of file entityhiddenattribute.cpp.

EntityHiddenAttribute::~EntityHiddenAttribute

(

)

Destroys the entity hidden attribute.

Definition at line 33 of file entityhiddenattribute.cpp.

Member Function Documentation

EntityHiddenAttribute * EntityHiddenAttribute::clone ( ) const

virtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 43 of file entityhiddenattribute.cpp.

void EntityHiddenAttribute::deserialize ( const QByteArray &  data )

virtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 53 of file entityhiddenattribute.cpp.

QByteArray EntityHiddenAttribute::serialized ( ) const

virtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 48 of file entityhiddenattribute.cpp.

QByteArray Akonadi::EntityHiddenAttribute::type ( ) const

virtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 37 of file entityhiddenattribute.cpp.

---

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

• entityhiddenattribute.h
• entityhiddenattribute.cpp