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

akonadi

Akonadi::CollectionStatistics

Akonadi::CollectionStatistics Class Reference

Provides statistics information of a Collection. More...

#include <collectionstatistics.h>

List of all members.

Public Member Functions

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

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 );
 connect( job, SIGNAL( result( KJob* ) ), SLOT( jobFinished( KJob* ) ) );

 ...

 MyClass::jobFinished( KJob *job )
 {
   if ( job->error() ) {
     qDebug() << "Error occurred";
     return;
   }

   CollectionStatisticsJob *statisticsJob = qobject_cast<CollectionStatisticsJob*>( job );

   const Akonadi::CollectionStatistics statistics = statisticsJob->statistics();
   qDebug() << "Unread items:" << statistics.unreadCount();
 }

This class is implicitely shared.

Author:
Volker Krause <vkrause@kde.org>

Definition at line 69 of file collectionstatistics.h.


Constructor & Destructor Documentation

CollectionStatistics::CollectionStatistics (  ) 

Creates a new collection statistics object.

Definition at line 54 of file collectionstatistics.cpp.

CollectionStatistics::CollectionStatistics ( const CollectionStatistics &  other  ) 

Creates a collection statistics object from an other one.

Definition at line 59 of file collectionstatistics.cpp.

CollectionStatistics::~CollectionStatistics (  ) 

Destroys the collection statistics object.

Definition at line 64 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 68 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 98 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 73 of file collectionstatistics.cpp.

void CollectionStatistics::setSize ( qint64  size  ) 

Sets the total size of the items in this collection.

Parameters:
size The total size of the items
See also:
size()
Since:
4.3

Definition at line 93 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 83 of file collectionstatistics.cpp.

qint64 CollectionStatistics::size (  )  const

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

See also:
setSize()
Since:
4.3

Definition at line 88 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 78 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
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.2-20100208
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