• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

Akonadi::CollectionStatistics

Akonadi::CollectionStatistics Class Reference

#include <collectionstatistics.h>

List of all members.


Detailed Description

Provides statistics information of a Collection.

This class contains information such as total number of items, number of new and unread items, etc.

These information might be expensive to obtain and are thus not included when fetching collection with a CollectionFetchJob. They can be retrieved spearately using CollectionStatisticsJob.

Example:

 Akonadi::Collection collection = ...

 Akonadi::CollectionStatisticsJob *job = new Akonadi::CollectionStatisticsJob( collection );
 if ( job->exec() ) {
   Akonadi::CollectionStatistics statistics = job->statistics();
   qDebug() << "Unread items:" << statistics.unreadCount();
 }

This class is implicitely shared.

Author:
Volker Krause <vkrause@kde.org>

Definition at line 57 of file collectionstatistics.h.


Public Member Functions

 CollectionStatistics (const CollectionStatistics &other)
 CollectionStatistics ()
qint64 count () const
CollectionStatistics & operator= (const CollectionStatistics &other)
void setCount (qint64 count)
void setUnreadCount (qint64 count)
qint64 unreadCount () const
 ~CollectionStatistics ()

Constructor & Destructor Documentation

CollectionStatistics::CollectionStatistics (  ) 

Creates a new collection statistics object.

Definition at line 50 of file collectionstatistics.cpp.

CollectionStatistics::CollectionStatistics ( const CollectionStatistics &  other  ) 

Creates a collection statistics object from an other one.

Definition at line 55 of file collectionstatistics.cpp.

CollectionStatistics::~CollectionStatistics (  ) 

Destroys the collection statistics object.

Definition at line 60 of file collectionstatistics.cpp.


Member Function Documentation

qint64 CollectionStatistics::count (  )  const

Returns the number of items in this collection or -1 if this information is not available.

See also:
setCount()

unreadCount()

Definition at line 64 of file collectionstatistics.cpp.

CollectionStatistics & CollectionStatistics::operator= ( const CollectionStatistics &  other  ) 

Assigns other to this statistics object and returns a reference to this one.

Definition at line 84 of file collectionstatistics.cpp.

void CollectionStatistics::setCount ( qint64  count  ) 

Sets the number of items in this collection.

Parameters:
count The number of items.
See also:
count()

Definition at line 69 of file collectionstatistics.cpp.

void CollectionStatistics::setUnreadCount ( qint64  count  ) 

Sets the number of unread items in this collection.

Parameters:
count The number of unread messages.
See also:
unreadCount()

Definition at line 79 of file collectionstatistics.cpp.

qint64 CollectionStatistics::unreadCount (  )  const

Returns the number of unread items in this collection or -1 if this information is not available.

See also:
setUnreadCount()

count()

Definition at line 74 of file collectionstatistics.cpp.


The documentation for this class was generated from the following files:
  • collectionstatistics.h
  • collectionstatistics.cpp

akonadi

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.6
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