akonadi
#include <collectionstatistics.h>
Public Member Functions | |
CollectionStatistics () | |
CollectionStatistics (const CollectionStatistics &other) | |
~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.
This information might be expensive to obtain and is thus not included when fetching collections with a CollectionFetchJob. It can be retrieved separately using CollectionStatisticsJob.
Example:
This class is implicitly shared.
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:
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:03:22 by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.