KMail::SortCacheItem Class Reference

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. More...

#include <headeritem.h>

List of all members.

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 (QPtrList< SortCacheItem > *list)
	SortCacheItem (int i, QString k, int o=-1)
	SortCacheItem ()
const QPtrList< SortCacheItem > *	sortedChildren () const
QPtrList< 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 ()

---

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 54 of file headeritem.h.

---

Constructor & Destructor Documentation

KMail::SortCacheItem::SortCacheItem

(

)

[inline]

Definition at line 57 of file headeritem.h.

KMail::SortCacheItem::SortCacheItem	(	int	i,
		QString	k,
		int	o = -1
	)			[inline]

Definition at line 60 of file headeritem.h.

KMail::SortCacheItem::~SortCacheItem

(

)

[inline]

Definition at line 64 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 92 of file headeritem.h.

void KMail::SortCacheItem::addUnsortedChild

(

SortCacheItem *

i

)

[inline]

Add an item to this itme's list of unsorted children.

Definition at line 97 of file headeritem.h.

void KMail::SortCacheItem::clearChildren

(

)

[inline]

Clear the sorted and unsorted children datastructures.

Definition at line 108 of file headeritem.h.

bool KMail::SortCacheItem::hasChildren

(

)

const [inline]

Returns whether the item has other items below it.

Definition at line 81 of file headeritem.h.

int KMail::SortCacheItem::id

(

)

const [inline]

Definition at line 125 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 74 of file headeritem.h.

HeaderItem* KMail::SortCacheItem::item

(

)

const [inline]

The corresponding KMail::HeaderItem.

Definition at line 116 of file headeritem.h.

const QString& KMail::SortCacheItem::key

(

)

const [inline]

sort key as used by the listview

Definition at line 121 of file headeritem.h.

int KMail::SortCacheItem::offset

(

)

const [inline]

offset in the cache file stream

Definition at line 129 of file headeritem.h.

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 68 of file headeritem.h.

void KMail::SortCacheItem::setId

(

int

id

)

[inline]

Definition at line 126 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 78 of file headeritem.h.

void KMail::SortCacheItem::setItem

(

HeaderItem *

i

)

[inline]

Set the corresponding KMail::HeaderItem.

Definition at line 118 of file headeritem.h.

void KMail::SortCacheItem::setKey

(

const QString &

key

)

[inline]

Set the sort key used by the list view.

Definition at line 123 of file headeritem.h.

void KMail::SortCacheItem::setOffset

(

int

x

)

[inline]

Definition at line 130 of file headeritem.h.

void KMail::SortCacheItem::setSubjectThreadingList

(

QPtrList< 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 138 of file headeritem.h.

const QPtrList<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 85 of file headeritem.h.

QPtrList<SortCacheItem>* KMail::SortCacheItem::subjectThreadingList

(

)

const [inline]

The list of mails with a certain subject that this item is on.

Definition at line 140 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 89 of file headeritem.h.

void SortCacheItem::updateSortFile	(	FILE *	sortStream,
		KMFolder *	folder,
		bool	waiting_for_parent = false,
		bool	update_discovered_count = false
	)

Definition at line 2830 of file kmheaders.cpp.

---

The documentation for this class was generated from the following files:

• headeritem.h
• kmheaders.cpp