KDE 4.1 API Reference kmail
KMail::SortCacheItem Class Reference
#include <headeritem.h>
Detailed Description
Represents an item in the set of mails to be displayed but only as far as sorting, threading and reading/writing of the current sort order to a disk cache is concerned.Each such item is paired with a KMail::HeaderItem, which holds the graphical representation of each item (mail). This is what the threading trees are built of.
Definition at line 59 of file headeritem.h.
Public Member Functions | |
| void | addSortedChild (SortCacheItem *i) |
| void | addUnsortedChild (SortCacheItem *i) |
| void | clearChildren () |
| bool | hasChildren () const |
| int | id () const |
| bool | isImperfectlyThreaded () const |
| HeaderItem * | item () const |
| const QString & | key () const |
| int | offset () const |
| SortCacheItem * | parent () const |
| void | setId (int id) |
| void | setImperfectlyThreaded (bool val) |
| void | setItem (HeaderItem *i) |
| void | setKey (const QString &key) |
| void | setOffset (int x) |
| void | setSubjectThreadingList (QList< SortCacheItem * > *list) |
| SortCacheItem (int i, QString k, int o=-1) | |
| SortCacheItem () | |
| const QList< SortCacheItem * > * | sortedChildren () const |
| QList< SortCacheItem * > * | subjectThreadingList () const |
| SortCacheItem ** | unsortedChildren (int &count) const |
| void | updateSortFile (FILE *sortStream, KMFolder *folder, bool waiting_for_parent=false, bool update_discovered_count=false) |
| ~SortCacheItem () | |
Constructor & Destructor Documentation
| KMail::SortCacheItem::SortCacheItem | ( | ) | [inline] |
Definition at line 62 of file headeritem.h.
| KMail::SortCacheItem::SortCacheItem | ( | int | i, | |
| QString | k, | |||
| int | o = -1 | |||
| ) | [inline] |
Definition at line 65 of file headeritem.h.
| KMail::SortCacheItem::~SortCacheItem | ( | ) | [inline] |
Definition at line 69 of file headeritem.h.
Member Function Documentation
| void KMail::SortCacheItem::addSortedChild | ( | SortCacheItem * | i | ) | [inline] |
Add an item to this itme's list of already sorted children.
Definition at line 97 of file headeritem.h.
| void KMail::SortCacheItem::addUnsortedChild | ( | SortCacheItem * | i | ) | [inline] |
| void KMail::SortCacheItem::clearChildren | ( | ) | [inline] |
| bool KMail::SortCacheItem::hasChildren | ( | ) | const [inline] |
| int KMail::SortCacheItem::id | ( | ) | const [inline] |
Definition at line 130 of file headeritem.h.
| bool KMail::SortCacheItem::isImperfectlyThreaded | ( | ) | const [inline] |
Returs whether the item is so far imperfectly threaded.
If an item is imperfectly threaded (by References or subject, not by In-Reply-To) it will be reevalutated when a new mail comes in. It could be the perfect parent.
Definition at line 79 of file headeritem.h.
| HeaderItem* KMail::SortCacheItem::item | ( | ) | const [inline] |
| const QString& KMail::SortCacheItem::key | ( | ) | const [inline] |
| int KMail::SortCacheItem::offset | ( | ) | const [inline] |
| SortCacheItem* KMail::SortCacheItem::parent | ( | void | ) | const [inline] |
The parent node of the item in the threading hierarchy.
0 if the item is at top level, which is the default. Can only be set by parents.
Definition at line 73 of file headeritem.h.
| void KMail::SortCacheItem::setId | ( | int | id | ) | [inline] |
Definition at line 131 of file headeritem.h.
| void KMail::SortCacheItem::setImperfectlyThreaded | ( | bool | val | ) | [inline] |
Set whether the item is currently imperfectly threaded (by References or Subject, not by In-Reply-To).
Definition at line 83 of file headeritem.h.
| void KMail::SortCacheItem::setItem | ( | HeaderItem * | i | ) | [inline] |
| void KMail::SortCacheItem::setKey | ( | const QString & | key | ) | [inline] |
| void KMail::SortCacheItem::setOffset | ( | int | x | ) | [inline] |
Definition at line 135 of file headeritem.h.
| void KMail::SortCacheItem::setSubjectThreadingList | ( | QList< SortCacheItem * > * | list | ) | [inline] |
Set the list of mails with a certain subject that this item is on.
Used to remove the item from that list on deletion.
Definition at line 143 of file headeritem.h.
| const QList<SortCacheItem*>* KMail::SortCacheItem::sortedChildren | ( | ) | const [inline] |
The sorted children are an array of sortcache items we know are below the current one and are already properly sorted (as read from the cache ).
Definition at line 90 of file headeritem.h.
| QList<SortCacheItem*>* KMail::SortCacheItem::subjectThreadingList | ( | ) | const [inline] |
The list of mails with a certain subject that this item is on.
Definition at line 145 of file headeritem.h.
| SortCacheItem** KMail::SortCacheItem::unsortedChildren | ( | int & | count | ) | const [inline] |
The unsorted children are an array of sortcache items we know are below the current one, but are yet to be threaded and sorted properly.
Definition at line 94 of file headeritem.h.
| void KMail::SortCacheItem::updateSortFile | ( | FILE * | sortStream, | |
| KMFolder * | folder, | |||
| bool | waiting_for_parent = false, |
|||
| bool | update_discovered_count = false | |||
| ) |
The documentation for this class was generated from the following file:
