kmail

KMHeaders Class Reference

#include <kmheaders.h>

Inheritance diagram for KMHeaders:

[legend]

List of all members.

Detailed Description

The widget that shows the contents of folders.

Definition at line 52 of file kmheaders.h.


Public Slots
void	decCurrentMessage ()
virtual void	ensureCurrentItemVisible ()
void	folderCleared ()
void	folderClosed ()
void	highlightMessage (Q3ListViewItem *)
void	incCurrentMessage ()
void	msgAdded (int)
void	msgChanged ()
void	msgHeaderChanged (KMFolder *folder, int msgId)
void	msgRemoved (int, const QString &)
void	nextMessage ()
bool	nextUnreadMessage (bool acceptCurrent=false)
void	prevMessage ()
bool	prevUnreadMessage ()
void	reset ()
void	resetCurrentTime ()
void	selectCurrentMessage ()
void	selectMessage (Q3ListViewItem *)
void	selectNextMessage ()
void	selectPrevMessage ()
void	setFolderInfoStatus ()
virtual void	setSelected (Q3ListViewItem *item, bool selected)
void	setSelectedByIndex (QList< int > items, bool selected)
void	slotExpandOrCollapseAllThreads (bool expand)
void	slotExpandOrCollapseThread (bool expand)
void	slotNoDrag ()
void	slotRMB ()
void	slotToggleColumn (QAction *, int mode=-1)
Signals
void	activated (KMMessage *)
void	maybeDeleting ()
void	messageListUpdated ()
void	msgAddedToListView (Q3ListViewItem *)
void	selected (KMMessage *)
Public Member Functions
virtual void	applyFiltersOnMsg ()
virtual bool	canUndo () const
virtual void	clearSelectableAndAboutToBeDeleted (quint32 serNum)
virtual void	copyMsgToFolder (KMFolder destination, KMMessage aMsg=0)
virtual HeaderItem *	currentHeaderItem ()
virtual int	currentItemIndex ()
virtual KMMessage *	currentMsg ()
QList< Q3ListViewItem * >	currentThread () const
QFont	dateFont () const
virtual void	deleteMsg ()
bool	eventFilter (QObject o, QEvent e)
virtual void	finalizeMove (HeaderItem *item, int contentX, int contentY)
virtual int	findUnread (bool findNext, int startAt=-1, bool onlyNew=false, bool acceptCurrent=false)
KMFolder *	folder (void)
const KMMsgBase *	getMsgBaseForItem (const Q3ListViewItem *item) const
NestingPolicy	getNestingPolicy () const
void	highlightCurrentThread ()
void	highlightMessage (Q3ListViewItem *, bool markitread)
QFont	importantFont () const
int	indexOfGetMsg (void) const
bool	isMessageCut (quint32 serNum) const
bool	isThreaded () const
	KMHeaders (KMMainWidget owner, QWidget parent=0)
virtual void	moveMsgToFolder (KMFolder *destination, bool askForConfirmation=true)
QFont	newFont () const
KMMainWidget *	owner (void) const
const KPaintInfo *	paintInfo (void) const
virtual HeaderItem *	prepareMove (int contentX, int contentY)
virtual void	readColorConfig (void)
virtual void	readConfig (void)
void	refreshNestedState (void)
QList< int >	selectedItems ()
virtual KMMessageList *	selectedMsgs (bool toBeDeleted=false)
QList< Q_UINT32 >	selectedSernums ()
QList< Q_UINT32 >	selectedVisibleSernums ()
void	setCopiedMessages (const QList< quint32 > &msgs, bool move)
virtual void	setCurrentItemByIndex (int msgIdx)
void	setCurrentItemBySerialNum (unsigned long serialNum)
virtual void	setCurrentMsg (int msgId)
virtual void	setFolder (KMFolder *, bool forceJumpToUnread=false)
virtual void	setMessageTagList (const QString &aLabel)
virtual void	setMsgRead (int msgId)
virtual void	setMsgStatus (const MessageStatus &status, bool toggle=false)
virtual void	setNestedOverride (bool override)
virtual void	setOpen (Q3ListViewItem *, bool)
virtual void	setSubjectThreading (bool subjThreading)
virtual void	setThreadStatus (const MessageStatus &status, bool toggle=false)
virtual void	setTopItemByIndex (int aMsgIdx)
QFont	todoFont () const
virtual int	topItemIndex ()
virtual void	undo ()
QFont	unreadFont () const
virtual	~KMHeaders ()
Static Public Member Functions
static QString	fancyDate (time_t otime)
Public Attributes
bool	noRepaint
uint	ascending: 1
short	column
uint	dirty: 1
uint	fakeSort: 1
uint	removed: 1
Protected Slots
virtual void	copySelectedToFolder (QAction *act)
void	dirtySortOrder (int)
virtual void	moveSelectedToFolder (QAction *act)
void	rightButtonPressed (Q3ListViewItem *, const QPoint &, int)
virtual int	slotFilterMsg (KMMessage *)
Protected Member Functions
void	contentsMouseMoveEvent (QMouseEvent *e)
virtual void	contentsMousePressEvent (QMouseEvent *)
virtual void	contentsMouseReleaseEvent (QMouseEvent *e)
virtual bool	event (QEvent *e)
void	findUnreadAux (HeaderItem *&, bool &, bool, bool)
virtual int	firstSelectedMsg () const
virtual void	keyPressEvent (QKeyEvent *e)
void	makeHeaderVisible ()
virtual void	paintEmptyArea (QPainter *p, const QRect &rect)
virtual void	readFolderConfig (void)
virtual void	setSorting (int column, bool ascending=true)
void	setStyleDependantFrameWidth ()
void	styleChange (QStyle &oldStyle)
virtual void	writeConfig (void)
virtual void	writeFolderConfig (void)
Static Protected Attributes
static QPixmap *	pixAttachment = 0
static QPixmap *	pixDel = 0
static QPixmap *	pixFiller
static QPixmap *	pixFlag = 0
static QPixmap *	pixFullyEncrypted = 0
static QPixmap *	pixFullySigned = 0
static QPixmap *	pixFwd = 0
static QPixmap *	pixHam = 0
static QPixmap *	pixIgnored = 0
static QPixmap *	pixNew = 0
static QPixmap *	pixPartiallyEncrypted = 0
static QPixmap *	pixPartiallySigned = 0
static QPixmap *	pixQueued = 0
static QPixmap *	pixRead = 0
static QPixmap *	pixReadFwd = 0
static QPixmap *	pixReadFwdReplied = 0
static QPixmap *	pixReadReplied = 0
static QPixmap *	pixRep = 0
static QPixmap *	pixSent = 0
static QPixmap *	pixSpam = 0
static QPixmap *	pixTodo = 0
static QPixmap *	pixUndefinedEncrypted = 0
static QPixmap *	pixUndefinedSigned = 0
static QPixmap *	pixUns = 0
static QPixmap *	pixWatched = 0

Constructor & Destructor Documentation

KMHeaders::KMHeaders	(	KMMainWidget *	owner,
		QWidget *	parent = `0`
	)			`[explicit]`

Definition at line 109 of file kmheaders.cpp.

KMHeaders::~KMHeaders ( ) [virtual]

Definition at line 248 of file kmheaders.cpp.

Member Function Documentation

void KMHeaders::activated ( KMMessage * ) [signal]

emitted when the list view item corresponding to this message has been double clicked

void KMHeaders::applyFiltersOnMsg ( ) [virtual]

Definition at line 1439 of file kmheaders.cpp.

bool KMHeaders::canUndo ( ) const [virtual]

Definition at line 1687 of file kmheaders.cpp.

void KMHeaders::clearSelectableAndAboutToBeDeleted ( quint32 serNum ) [virtual]

Resets toBeDeleted and selectable status of all selected items.

Definition at line 1771 of file kmheaders.cpp.

void KMHeaders::contentsMouseMoveEvent ( QMouseEvent * e ) [protected]

To initiate a drag operation.

Definition at line 2402 of file kmheaders.cpp.

void KMHeaders::contentsMousePressEvent ( QMouseEvent * e ) [protected, virtual]

Handle shift and control selection.

Definition at line 2301 of file kmheaders.cpp.

void KMHeaders::contentsMouseReleaseEvent ( QMouseEvent * e ) [protected, virtual]

Definition at line 2393 of file kmheaders.cpp.

void KMHeaders::copyMsgToFolder	(	KMFolder *	destination,
		KMMessage *	aMsg = `0`
	)			`[virtual]`

Messages are duplicated and added to given folder.

If aMsg is set this one will be written to the destination folder.

Definition at line 1707 of file kmheaders.cpp.

void KMHeaders::copySelectedToFolder ( QAction * act ) [protected, virtual, slot]

Same thing but copy.

Definition at line 1699 of file kmheaders.cpp.

HeaderItem * KMHeaders::currentHeaderItem ( ) [virtual]

Return the current list view item.

Definition at line 2560 of file kmheaders.cpp.

int KMHeaders::currentItemIndex ( ) [virtual]

Return the index of the message corresponding to the current item.

Definition at line 2566 of file kmheaders.cpp.

KMMessage * KMHeaders::currentMsg ( ) [virtual]

Return the current message.

Definition at line 2550 of file kmheaders.cpp.

QList< Q3ListViewItem * > KMHeaders::currentThread ( ) const

Get a list of all items in the current thread.

Definition at line 1292 of file kmheaders.cpp.

QFont KMHeaders::dateFont ( ) const [inline]

Definition at line 194 of file kmheaders.h.

void KMHeaders::decCurrentMessage ( ) [slot]

Focus the previous message, but don't select it.

Definition at line 1933 of file kmheaders.cpp.

void KMHeaders::deleteMsg ( ) [virtual]

Definition at line 1540 of file kmheaders.cpp.

void KMHeaders::dirtySortOrder ( int column ) [protected, slot]

dirties the sort order

Definition at line 2892 of file kmheaders.cpp.

void KMHeaders::ensureCurrentItemVisible ( ) [virtual, slot]

Definition at line 2096 of file kmheaders.cpp.

bool KMHeaders::event ( QEvent * e ) [protected, virtual]

Look for color changes.

Definition at line 435 of file kmheaders.cpp.

bool KMHeaders::eventFilter	(	QObject *	o,
		QEvent *	e
	)

Definition at line 264 of file kmheaders.cpp.

static QString KMHeaders::fancyDate ( time_t otime ) [static]

return a string relativ to the current time

void KMHeaders::finalizeMove	(	HeaderItem *	item,
		int	contentX,
		int	contentY
	)			`[virtual]`

Definition at line 1596 of file kmheaders.cpp.

int KMHeaders::findUnread	(	bool	findNext,
		int	startAt = `-1`,
		bool	onlyNew = `false`,
		bool	acceptCurrent = `false`
	)			`[virtual]`

Find next/prev unread message.

Starts at currentItem() if startAt is unset.

Definition at line 2001 of file kmheaders.cpp.

void KMHeaders::findUnreadAux	(	HeaderItem *&	item,
		bool &	foundUnreadMessage,
		bool	onlyNew,
		bool	aDirNext
	)			`[protected]`

Auxillary method to findUnread.

Definition at line 1958 of file kmheaders.cpp.

int KMHeaders::firstSelectedMsg ( ) const [protected, virtual]

Returns message index of first selected message of the messages where the message with the given id is in.

This for finding the correct message that shall be the current message after move/delete of multiple messages.

Definition at line 1824 of file kmheaders.cpp.

KMFolder* KMHeaders::folder ( void ) [inline]

Return the folder whose message headers are being displayed.

Definition at line 69 of file kmheaders.h.

void KMHeaders::folderCleared ( ) [slot]

For when the folder has been cleared.

Definition at line 2723 of file kmheaders.cpp.

void KMHeaders::folderClosed ( ) [slot]

For when the folder has been cleared.

Definition at line 2732 of file kmheaders.cpp.

const KMMsgBase * KMHeaders::getMsgBaseForItem ( const Q3ListViewItem * item ) const

gets the message represented by the item as a KMMsgBase.

Definition at line 2642 of file kmheaders.cpp.

NestingPolicy KMHeaders::getNestingPolicy ( ) const [inline]

Definition at line 165 of file kmheaders.h.

void KMHeaders::highlightCurrentThread ( )

Definition at line 2178 of file kmheaders.cpp.

void KMHeaders::highlightMessage ( Q3ListViewItem * i ) [slot]

For when a list view item has been selected.

Definition at line 2447 of file kmheaders.cpp.

void KMHeaders::highlightMessage	(	Q3ListViewItem *	lvi,
		bool	markitread
	)

Definition at line 2138 of file kmheaders.cpp.

QFont KMHeaders::importantFont ( ) const [inline]

Definition at line 192 of file kmheaders.h.

void KMHeaders::incCurrentMessage ( ) [slot]

Focus the next message, but don't select it.

Definition at line 1914 of file kmheaders.cpp.

int KMHeaders::indexOfGetMsg ( void ) const [inline]

Returns index of message returned by last getMsg() call.

Definition at line 131 of file kmheaders.h.

bool KMHeaders::isMessageCut ( quint32 serNum ) const

Returns true if the message with the given serial number has been cut.

Parameters:

serNum

A message serial number.

Definition at line 3602 of file kmheaders.cpp.

bool KMHeaders::isThreaded ( ) const [inline]

Returns true if the current header list is threaded.

Definition at line 167 of file kmheaders.h.

void KMHeaders::keyPressEvent ( QKeyEvent * e ) [protected, virtual]

Definition at line 2243 of file kmheaders.cpp.

void KMHeaders::makeHeaderVisible ( ) [protected]

Ensure the current item is visible.

Definition at line 2131 of file kmheaders.cpp.

void KMHeaders::maybeDeleting ( ) [signal]

emitted when we might be about to delete messages

void KMHeaders::messageListUpdated ( ) [signal]

emitted when the list of messages has been completely rebuilt

void KMHeaders::moveMsgToFolder	(	KMFolder *	destination,
		bool	askForConfirmation = `true`
	)			`[virtual]`

If destination is 0 then the messages are deleted, otherwise they are moved to this folder.

The second parameter is useful when the user has already confirmed the move/deletion.

Definition at line 1617 of file kmheaders.cpp.

void KMHeaders::moveSelectedToFolder ( QAction * act ) [protected, virtual, slot]

Move messages corresponding to the selected items to the folder corresponding to the given QAction.

Definition at line 1562 of file kmheaders.cpp.

void KMHeaders::msgAdded ( int id ) [slot]

For when the message with the given message id has been added to a folder.

Definition at line 890 of file kmheaders.cpp.

void KMHeaders::msgAddedToListView ( Q3ListViewItem * ) [signal]

emitted after a new item has been fully built and added to the list view.

We can't use K3ListView::itemAdded, as that is emitted from the ctor of the item, at which point the building of the item is not yet far enough along to update the quick search, which is what is connected to this signal.

void KMHeaders::msgChanged ( ) [slot]

For when the list of messages in a folder has changed.

Definition at line 820 of file kmheaders.cpp.

void KMHeaders::msgHeaderChanged	(	KMFolder *	folder,
		int	msgId
	)			`[slot]`

Refresh list view item corresponding to the messae with the given id.

Definition at line 1205 of file kmheaders.cpp.

void KMHeaders::msgRemoved	(	int	id,
		const QString &	msgId
	)			`[slot]`

For when the message with the given id has been removed for a folder.

Definition at line 1077 of file kmheaders.cpp.

QFont KMHeaders::newFont ( ) const [inline]

Definition at line 190 of file kmheaders.h.

void KMHeaders::nextMessage ( ) [slot]

Make the next header visible scrolling if necessary.

Definition at line 1837 of file kmheaders.cpp.

bool KMHeaders::nextUnreadMessage ( bool acceptCurrent = false ) [slot]

Make the nextUnread message header visible scrolling if necessary, returning true if an unread message is found.

Definition at line 2078 of file kmheaders.cpp.

KMMainWidget* KMHeaders::owner ( void ) const [inline]

Returns pointer to owning main window.

Definition at line 134 of file kmheaders.h.

void KMHeaders::paintEmptyArea	(	QPainter *	p,
		const QRect &	rect
	)			`[protected, virtual]`

Overridden to support backing pixmap.

Definition at line 424 of file kmheaders.cpp.

const KPaintInfo* KMHeaders::paintInfo ( void ) const [inline]

PaintInfo pointer.

Definition at line 137 of file kmheaders.h.

HeaderItem * KMHeaders::prepareMove	(	int *	contentX,
		int *	contentY
	)			`[virtual]`

Definition at line 1569 of file kmheaders.cpp.

void KMHeaders::prevMessage ( ) [slot]

Make the previous header visible scrolling if necessary.

Definition at line 1875 of file kmheaders.cpp.

bool KMHeaders::prevUnreadMessage ( ) [slot]

Make the previous message header visible scrolling if necessary, returning true if an unread message is found.

Definition at line 2104 of file kmheaders.cpp.

void KMHeaders::readColorConfig ( void ) [virtual]

Read color options and set palette.

Definition at line 447 of file kmheaders.cpp.

void KMHeaders::readConfig ( void ) [virtual]

Read config options.

Definition at line 488 of file kmheaders.cpp.

void KMHeaders::readFolderConfig ( void ) [protected, virtual]

Read per-folder config options and apply them.

Definition at line 613 of file kmheaders.cpp.

void KMHeaders::refreshNestedState ( void )

read the config file and update nested state if necessary

Definition at line 594 of file kmheaders.cpp.

void KMHeaders::reset ( ) [slot]

Refresh the list of message headers shown.

Definition at line 575 of file kmheaders.cpp.

void KMHeaders::resetCurrentTime ( ) [slot]

timer function to set the current time regularly

Definition at line 2186 of file kmheaders.cpp.

void KMHeaders::rightButtonPressed	(	Q3ListViewItem *	lvi,
		const QPoint &	,
		int
	)			`[protected, slot]`

show context menu

Definition at line 2288 of file kmheaders.cpp.

void KMHeaders::selectCurrentMessage ( ) [slot]

Select the message which currently has focus, if it's not already selected.

Definition at line 1951 of file kmheaders.cpp.

void KMHeaders::selected ( KMMessage * ) [signal]

emitted when the list view item corresponding to this message has been selected

QList< int > KMHeaders::selectedItems ( )

Returns the index values of currently selected items.

Definition at line 1809 of file kmheaders.cpp.

KMMessageList * KMHeaders::selectedMsgs ( bool toBeDeleted = false ) [virtual]

Returns list of selected messages.

Mark the corresponding header items to be deleted, if specified.

Definition at line 1788 of file kmheaders.cpp.

QList< Q_UINT32 > KMHeaders::selectedSernums ( )

Returns the sernums of all selected items.

Definition at line 3607 of file kmheaders.cpp.

QList< Q_UINT32 > KMHeaders::selectedVisibleSernums ( )

Returns the sernums of all visible (ie.

items with expanded parent, not hidden by eg. the quick search) selected items.

Definition at line 3621 of file kmheaders.cpp.

void KMHeaders::selectMessage ( Q3ListViewItem * lvi ) [slot]

For when a list view item has been double clicked.

Definition at line 2193 of file kmheaders.cpp.

void KMHeaders::selectNextMessage ( ) [slot]

Same as nextMessage() but don't clear the current selection.

Definition at line 1849 of file kmheaders.cpp.

void KMHeaders::selectPrevMessage ( ) [slot]

Same as prevMessage() but don't clear the current selection.

Definition at line 1887 of file kmheaders.cpp.

void KMHeaders::setCopiedMessages	(	const QList< quint32 > &	msgs,
		bool	move
	)

Sets the list of copied/cutted messages.

Parameters:

	msgs	A list of serial numbers.
	move	if true, the messages were cutted

Definition at line 3595 of file kmheaders.cpp.

void KMHeaders::setCurrentItemByIndex ( int msgIdx ) [virtual]

Set the current item to the one corresponding to the given msg id.

Definition at line 2576 of file kmheaders.cpp.

void KMHeaders::setCurrentItemBySerialNum ( unsigned long serialNum )

Set the current item to the one corresponding to the given serial number (slow!).

Definition at line 3519 of file kmheaders.cpp.

void KMHeaders::setCurrentMsg ( int msgId ) [virtual]

Set current message.

If id<0 then the first message is shown, if id>count() the last message is shown.

Definition at line 1725 of file kmheaders.cpp.

void KMHeaders::setFolder	(	KMFolder *	aFolder,
		bool	forceJumpToUnread = `false`
	)			`[virtual]`

A new folder has been selected update the list of headers shown To override the global settings for jumping to the first unread msg use forceJumpToUnread.

Definition at line 681 of file kmheaders.cpp.

void KMHeaders::setFolderInfoStatus ( ) [slot]

Provide information about number of messages in a folder.

Definition at line 1421 of file kmheaders.cpp.

void KMHeaders::setMessageTagList ( const QString & aLabel ) [virtual]

Toggles the tag that is identified through aLabel for every selected message.

Parameters:

aLabel

10 letter label that corresponds to the tag to be toggled

Definition at line 1218 of file kmheaders.cpp.

void KMHeaders::setMsgRead ( int msgId ) [virtual]

Definition at line 1523 of file kmheaders.cpp.

void KMHeaders::setMsgStatus	(	const MessageStatus &	status,
		bool	toggle = `false`
	)			`[virtual]`

The following methods processes all selected messages.

Definition at line 1261 of file kmheaders.cpp.

void KMHeaders::setNestedOverride ( bool override ) [virtual]

Definition at line 2613 of file kmheaders.cpp.

void KMHeaders::setOpen	(	Q3ListViewItem *	item,
		bool	open
	)			`[virtual]`

Double force items to always be open.

Definition at line 2635 of file kmheaders.cpp.

kmail

KMHeaders Class Reference

Detailed Description

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Slots

Protected Member Functions

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation