• Skip to content
  • Skip to link menu
KDE 4.7 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • EntityHiddenAttribute
Public Member Functions
Akonadi::EntityHiddenAttribute Class Reference

#include <entityhiddenattribute.h>

Inheritance diagram for Akonadi::EntityHiddenAttribute:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 EntityHiddenAttribute ()
 ~EntityHiddenAttribute ()
EntityHiddenAttribute * clone () const
void deserialize (const QByteArray &data)
QByteArray serialized () const
QByteArray type () const

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.stefanek@gmail.com>
See also:
Akonadi::Attribute
Since:
4.4

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* Akonadi::EntityHiddenAttribute::clone ( ) const [virtual]

Reimplemented from Attribute.

Implements Akonadi::Attribute.

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

Reimplemented from Attribute.

Implements Akonadi::Attribute.

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

Reimplemented from Attribute.

Implements Akonadi::Attribute.

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

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal