kmail Library API Documentation

KMHeaders Class Reference

The widget that shows the contents of folders. More...

#include <kmheaders.h>

List of all members.

Public Slots

void workAroundQListViewLimitation ()
void selectMessage (QListViewItem *)
void highlightMessage (QListViewItem *)
void slotRMB ()
void msgHeaderChanged (KMFolder *folder, int msgId)
void msgChanged ()
void folderCleared ()
void msgAdded (int)
void msgRemoved (int, QString, QString)
void nextMessage ()
void selectNextMessage ()
void prevMessage ()
void selectPrevMessage ()
bool nextUnreadMessage (bool acceptCurrent=false)
bool prevUnreadMessage ()
void slotNoDrag ()
void resetCurrentTime ()
void slotExpandOrCollapseThread (bool expand)
void slotExpandOrCollapseAllThreads (bool expand)
virtual void ensureCurrentItemVisible ()
virtual void setSelected (QListViewItem *item, bool selected)
void slotToggleSizeColumn ()
void setFolderInfoStatus ()

Signals

virtual void selected (KMMessage *)
virtual void activated (KMMessage *)
virtual void maybeDeleting ()

Public Member Functions

 KMHeaders (KMMainWidget *owner, QWidget *parent=0, const char *name=0)
virtual void setFolder (KMFolder *, bool jumpToFirst=false)
KMFolderfolder (void)
void refreshNestedState (void)
virtual void setCurrentMsg (int msgId)
QPtrList< QListViewItem > currentThread () const
virtual void setThreadStatus (KMMsgStatus status, bool toggle=false)
virtual void setMsgRead (int msgId)
virtual void setMsgStatus (KMMsgStatus status, bool toggle=false)
virtual void deleteMsg ()
virtual void applyFiltersOnMsg ()
virtual void undo ()
virtual bool canUndo () const
virtual void resendMsg ()
virtual KMHeaderItem * prepareMove (int *contentX, int *contentY)
virtual void finalizeMove (KMHeaderItem *item, int contentX, int contentY)
virtual void moveMsgToFolder (KMFolder *destination)
virtual void copyMsgToFolder (KMFolder *destination, KMMessage *aMsg=0)
virtual void clearSelectableAndAboutToBeDeleted (Q_UINT32 serNum)
virtual KMMessageList * selectedMsgs (bool toBeDeleted=false)
int indexOfGetMsg (void) const
KMMainWidget * owner (void) const
const KPaintInfo * paintInfo (void) const
virtual void readConfig (void)
virtual void readColorConfig (void)
virtual void reset (void)
void showNewMail ()
virtual KMMessage * currentMsg ()
virtual KMHeaderItem * currentHeaderItem ()
virtual int currentItemIndex ()
virtual void setCurrentItemByIndex (int msgIdx)
virtual int topItemIndex ()
virtual void setTopItemByIndex (int aMsgIdx)
virtual void setNestedOverride (bool override)
virtual void setSubjectThreading (bool subjThreading)
virtual void setOpen (QListViewItem *, bool)
NestingPolicy getNestingPolicy () const
bool isThreaded () const
virtual int findUnread (bool findNext, int startAt=-1, bool onlyNew=false, bool acceptCurrent=false)
LoopOnGotoUnreadValue loopOnGotoUnread ()
void highlightMessage (QListViewItem *, bool markitread)
bool eventFilter (QObject *o, QEvent *e)

Static Public Member Functions

QString fancyDate (time_t otime)

Public Attributes

QFont dateFont
bool noRepaint

Protected Slots

virtual void moveSelectedToFolder (int menuId)
virtual void copySelectedToFolder (int menuId)
virtual int slotFilterMsg (KMMessage *)
void dirtySortOrder (int)
void rightButtonPressed (QListViewItem *, const QPoint &, int)

Protected Member Functions

virtual bool event (QEvent *e)
virtual void paintEmptyArea (QPainter *p, const QRect &rect)
void makeHeaderVisible ()
void findUnreadAux (KMHeaderItem *&, bool &, bool, bool)
virtual int firstSelectedMsg () const
virtual void readFolderConfig (void)
virtual void writeFolderConfig (void)
virtual void writeConfig (void)
virtual void contentsMousePressEvent (QMouseEvent *)
virtual void contentsMouseReleaseEvent (QMouseEvent *e)
virtual void keyPressEvent (QKeyEvent *e)
virtual void setSorting (int column, bool ascending=true)
void contentsMouseMoveEvent (QMouseEvent *e)
void styleChange (QStyle &oldStyle)
void setStyleDependantFrameWidth ()

Static Protected Attributes

QPixmap * pixNew = 0
QPixmap * pixUns = 0
QPixmap * pixDel = 0
QPixmap * pixRead = 0
QPixmap * pixRep = 0
QPixmap * pixSent = 0
QPixmap * pixQueued = 0
QPixmap * pixFwd = 0
QPixmap * pixFlag = 0
QPixmap * pixWatched = 0
QPixmap * pixIgnored = 0
QPixmap * pixSpam = 0
QPixmap * pixHam = 0
QPixmap * pixFullySigned = 0
QPixmap * pixPartiallySigned = 0
QPixmap * pixUndefinedSigned = 0
QPixmap * pixFullyEncrypted = 0
QPixmap * pixPartiallyEncrypted = 0
QPixmap * pixUndefinedEncrypted = 0
QPixmap * pixFiller
QPixmap * pixEncryptionProblematic = 0
QPixmap * pixSignatureProblematic = 0


Detailed Description

The widget that shows the contents of folders.

Definition at line 34 of file kmheaders.h.


Member Function Documentation

void KMHeaders::setFolder KMFolder ,
bool  jumpToFirst = false
[virtual]
 

A new folder has been selected update the list of headers shown.

Definition at line 892 of file kmheaders.cpp.

References currentItemIndex(), folderCleared(), highlightMessage(), isThreaded(), makeHeaderVisible(), msgAdded(), msgChanged(), msgHeaderChanged(), msgRemoved(), readFolderConfig(), setCurrentMsg(), setFolderInfoStatus(), setTopItemByIndex(), topItemIndex(), and writeFolderConfig().

Referenced by slotToggleSizeColumn().

KMFolder* KMHeaders::folder void   )  [inline]
 

Return the folder whose message headers are being displayed.

Definition at line 47 of file kmheaders.h.

void KMHeaders::refreshNestedState void   ) 
 

read the config file and update nested state if necessary

Definition at line 822 of file kmheaders.cpp.

References isThreaded(), and reset().

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 1858 of file kmheaders.cpp.

References KMFolder::count(), makeHeaderVisible(), setFolderInfoStatus(), and setSelected().

Referenced by msgChanged(), nextUnreadMessage(), prevUnreadMessage(), reset(), setFolder(), and slotExpandOrCollapseThread().

QPtrList< QListViewItem > KMHeaders::currentThread  )  const
 

Get a list of all items in the current thread.

Definition at line 1427 of file kmheaders.cpp.

void KMHeaders::setThreadStatus KMMsgStatus  status,
bool  toggle = false
[virtual]
 

Set all messages in the current thread to status status or toggle it, if specified.

Definition at line 1449 of file kmheaders.cpp.

void KMHeaders::setMsgStatus KMMsgStatus  status,
bool  toggle = false
[virtual]
 

The following methods processes all selected messages.

Definition at line 1410 of file kmheaders.cpp.

References KMFolder::getMsgBase().

void KMHeaders::moveMsgToFolder KMFolder destination  )  [virtual]
 

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

Definition at line 1754 of file kmheaders.cpp.

References selectedMsgs().

Referenced by moveSelectedToFolder().

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 1840 of file kmheaders.cpp.

References selectedMsgs().

Referenced by copySelectedToFolder().

void KMHeaders::clearSelectableAndAboutToBeDeleted Q_UINT32  serNum  )  [virtual]
 

Resets toBeDeleted and selectable status of all selected items.

Definition at line 1889 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 1906 of file kmheaders.cpp.

References KMFolder::getMsgBase().

Referenced by copyMsgToFolder(), and moveMsgToFolder().

int KMHeaders::indexOfGetMsg void   )  const [inline]
 

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

Definition at line 92 of file kmheaders.h.

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

Returns pointer to owning main window.

Definition at line 95 of file kmheaders.h.

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

PaintInfo pointer.

Definition at line 98 of file kmheaders.h.

void KMHeaders::readConfig void   )  [virtual]
 

Read config options.

Definition at line 751 of file kmheaders.cpp.

References readColorConfig().

void KMHeaders::readColorConfig void   )  [virtual]
 

Read color options and set palette.

Definition at line 712 of file kmheaders.cpp.

Referenced by readConfig().

void KMHeaders::reset void   )  [virtual]
 

Refresh the list of message headers shown.

Definition at line 807 of file kmheaders.cpp.

References currentItemIndex(), setCurrentMsg(), setTopItemByIndex(), and topItemIndex().

Referenced by refreshNestedState().

void KMHeaders::showNewMail  ) 
 

Scroll to show new mail.

Definition at line 2573 of file kmheaders.cpp.

References currentItemIndex(), KMFolder::getMsgBase(), and setTopItemByIndex().

KMMessage * KMHeaders::currentMsg  )  [virtual]
 

Return the current message.

Definition at line 2522 of file kmheaders.cpp.

References currentHeaderItem(), and KMFolder::getMsg().

Referenced by slotRMB().

KMHeaderItem * KMHeaders::currentHeaderItem  )  [virtual]
 

Return the current list view item.

Definition at line 2532 of file kmheaders.cpp.

Referenced by currentItemIndex(), currentMsg(), findUnread(), and msgRemoved().

int KMHeaders::currentItemIndex  )  [virtual]
 

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

Definition at line 2538 of file kmheaders.cpp.

References currentHeaderItem().

Referenced by msgChanged(), reset(), setFolder(), showNewMail(), and writeFolderConfig().

void KMHeaders::setCurrentItemByIndex int  msgIdx  )  [virtual]
 

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

Definition at line 2548 of file kmheaders.cpp.

References highlightMessage(), and setSelected().

int KMHeaders::topItemIndex  )  [virtual]
 

Return the message id of the top most visible item.

Definition at line 2562 of file kmheaders.cpp.

Referenced by msgChanged(), reset(), setFolder(), and writeFolderConfig().

void KMHeaders::setTopItemByIndex int  aMsgIdx  )  [virtual]
 

Make the item corresponding to the message with the given id the top most visible item.

Definition at line 2586 of file kmheaders.cpp.

Referenced by msgChanged(), reset(), setFolder(), and showNewMail().

void KMHeaders::setOpen QListViewItem *  ,
bool 
[virtual]
 

Double force items to always be open.

Definition at line 2620 of file kmheaders.cpp.

bool KMHeaders::isThreaded  )  const [inline]
 

Returns true if the current header list is threaded.

Definition at line 132 of file kmheaders.h.

Referenced by msgAdded(), msgRemoved(), readFolderConfig(), refreshNestedState(), setFolder(), setSelected(), and slotExpandOrCollapseThread().

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 2046 of file kmheaders.cpp.

References KMFolder::correctUnreadMsgsCount(), KMFolder::count(), KMFolder::countUnread(), currentHeaderItem(), and findUnreadAux().

Referenced by nextUnreadMessage(), and prevUnreadMessage().

LoopOnGotoUnreadValue KMHeaders::loopOnGotoUnread  )  [inline]
 

Return the config option LoopOnGotoUnread.

Definition at line 141 of file kmheaders.h.

QString KMHeaders::fancyDate time_t  otime  )  [static]
 

return a string relativ to the current time

virtual void KMHeaders::selected KMMessage *   )  [virtual, signal]
 

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

Referenced by msgChanged().

virtual void KMHeaders::activated KMMessage *   )  [virtual, signal]
 

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

Referenced by selectMessage().

virtual void KMHeaders::maybeDeleting  )  [virtual, signal]
 

emitted when we might be about to delete messages

Referenced by msgChanged().

void KMHeaders::selectMessage QListViewItem *   )  [slot]
 

For when a list view item has been double clicked.

Definition at line 2232 of file kmheaders.cpp.

References activated(), and KMFolder::getMsg().

void KMHeaders::highlightMessage QListViewItem *   )  [slot]
 

For when a list view item has been selected.

Definition at line 2443 of file kmheaders.cpp.

Referenced by contentsMousePressEvent(), msgAdded(), msgChanged(), msgRemoved(), setCurrentItemByIndex(), and setFolder().

void KMHeaders::slotRMB  )  [slot]
 

For when righ mouse button is pressed.

Definition at line 2449 of file kmheaders.cpp.

References currentMsg().

Referenced by rightButtonPressed().

void KMHeaders::msgHeaderChanged KMFolder folder,
int  msgId
[slot]
 

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

Definition at line 1398 of file kmheaders.cpp.

Referenced by msgAdded(), and setFolder().

void KMHeaders::msgChanged  )  [slot]
 

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

Definition at line 1054 of file kmheaders.cpp.

References KMFolder::count(), currentItemIndex(), KMFolder::getMsg(), KMFolder::getMsgBase(), highlightMessage(), maybeDeleting(), selected(), setCurrentMsg(), setSelected(), setTopItemByIndex(), and topItemIndex().

Referenced by setFolder().

void KMHeaders::folderCleared  )  [slot]
 

For when the folder has been cleared.

Definition at line 2697 of file kmheaders.cpp.

Referenced by msgRemoved(), and setFolder().

void KMHeaders::msgAdded int   )  [slot]
 

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

Definition at line 1106 of file kmheaders.cpp.

References KMFolder::count(), dirtySortOrder(), KMFolder::getMsgBase(), highlightMessage(), isThreaded(), makeHeaderVisible(), msgHeaderChanged(), setSelected(), and KMFolder::setStatus().

Referenced by setFolder().

void KMHeaders::msgRemoved int  ,
QString  ,
QString 
[slot]
 

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

Definition at line 1290 of file kmheaders.cpp.

References KMFolder::count(), currentHeaderItem(), dirtySortOrder(), folderCleared(), highlightMessage(), and isThreaded().

Referenced by setFolder().

void KMHeaders::nextMessage  )  [slot]
 

Make the next header visible scrolling if necessary.

Definition at line 1938 of file kmheaders.cpp.

References selectNextMessage(), and setSelected().

void KMHeaders::selectNextMessage  )  [slot]
 

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

Definition at line 1950 of file kmheaders.cpp.

Referenced by nextMessage().

void KMHeaders::prevMessage  )  [slot]
 

Make the previous header visible scrolling if necessary.

Definition at line 1972 of file kmheaders.cpp.

References selectPrevMessage(), and setSelected().

void KMHeaders::selectPrevMessage  )  [slot]
 

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

Definition at line 1984 of file kmheaders.cpp.

Referenced by prevMessage().

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 2123 of file kmheaders.cpp.

References KMFolder::countUnread(), findUnread(), and setCurrentMsg().

bool KMHeaders::prevUnreadMessage  )  [slot]
 

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

Definition at line 2148 of file kmheaders.cpp.

References KMFolder::countUnread(), findUnread(), and setCurrentMsg().

void KMHeaders::slotNoDrag  )  [slot]
 

Don't show a drag cursor.

Definition at line 2166 of file kmheaders.cpp.

void KMHeaders::resetCurrentTime  )  [slot]
 

timer function to set the current time regularly

Definition at line 2225 of file kmheaders.cpp.

void KMHeaders::slotExpandOrCollapseThread bool  expand  )  [slot]
 

Expands (expand == true) or collapses (expand == false) the current thread.

Definition at line 1490 of file kmheaders.cpp.

References isThreaded(), and setCurrentMsg().

void KMHeaders::slotExpandOrCollapseAllThreads bool  expand  )  [slot]
 

Expands (expand == true) or collapses (expand == false) all threads.

Definition at line 1507 of file kmheaders.cpp.

void KMHeaders::setSelected QListViewItem *  item,
bool  selected
[virtual, slot]
 

Select an item and if it is the parent of a closed thread, also recursively select its children.

Definition at line 1873 of file kmheaders.cpp.

References isThreaded().

Referenced by contentsMousePressEvent(), msgAdded(), msgChanged(), nextMessage(), prevMessage(), rightButtonPressed(), setCurrentItemByIndex(), and setCurrentMsg().

void KMHeaders::slotToggleSizeColumn  )  [slot]
 

switch size-column

Definition at line 673 of file kmheaders.cpp.

References setFolder().

void KMHeaders::setFolderInfoStatus  )  [slot]
 

Provide information about number of messages in a folder.

Definition at line 1550 of file kmheaders.cpp.

References KMFolder::count(), KMFolder::countUnread(), KMBroadcastStatus::instance(), KMFolder::isReadOnly(), and KMBroadcastStatus::setStatusMsg().

Referenced by setCurrentMsg(), and setFolder().

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

Look for color changes.

Definition at line 700 of file kmheaders.cpp.

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

Overridden to support backing pixmap.

Definition at line 689 of file kmheaders.cpp.

void KMHeaders::makeHeaderVisible  )  [protected]
 

Ensure the current item is visible.

Definition at line 2173 of file kmheaders.cpp.

Referenced by msgAdded(), setCurrentMsg(), and setFolder().

void KMHeaders::findUnreadAux KMHeaderItem *&  ,
bool &  ,
bool  ,
bool 
[protected]
 

Auxillary method to findUnread.

Definition at line 2007 of file kmheaders.cpp.

References KMFolder::getMsgBase().

Referenced by findUnread().

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 1925 of file kmheaders.cpp.

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

Read per-folder config options and apply them.

Definition at line 841 of file kmheaders.cpp.

References KMFolder::idString(), and isThreaded().

Referenced by setFolder().

void KMHeaders::writeFolderConfig void   )  [protected, virtual]
 

Write per-folder config options.

Definition at line 870 of file kmheaders.cpp.

References currentItemIndex(), KMFolder::idString(), and topItemIndex().

Referenced by setFolder(), and setSorting().

void KMHeaders::writeConfig void   )  [protected, virtual]
 

Write global config options.

Definition at line 886 of file kmheaders.cpp.

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

Handle shift and control selection.

Definition at line 2341 of file kmheaders.cpp.

References highlightMessage(), and setSelected().

void KMHeaders::setSorting int  column,
bool  ascending = true
[protected, virtual]
 

Called when a header is clicked.

Definition at line 2627 of file kmheaders.cpp.

References dirtySortOrder(), and writeFolderConfig().

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

To initiate a drag operation.

Definition at line 2405 of file kmheaders.cpp.

References KMFolder::getMsgBase().

void KMHeaders::styleChange QStyle &  oldStyle  )  [protected]
 

reimplemented in order to update the frame width in case of a changed GUI style

Definition at line 1543 of file kmheaders.cpp.

References setStyleDependantFrameWidth().

void KMHeaders::setStyleDependantFrameWidth  )  [protected]
 

Set the width of the frame to a reasonable value for the current GUI style.

Definition at line 1532 of file kmheaders.cpp.

Referenced by styleChange().

void KMHeaders::moveSelectedToFolder int  menuId  )  [protected, virtual, slot]
 

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

Definition at line 1699 of file kmheaders.cpp.

References moveMsgToFolder().

void KMHeaders::copySelectedToFolder int  menuId  )  [protected, virtual, slot]
 

Same thing but copy.

Definition at line 1832 of file kmheaders.cpp.

References copyMsgToFolder().

int KMHeaders::slotFilterMsg KMMessage *   )  [protected, virtual, slot]
 

Apply the filter Rules to a single message.

Definition at line 1469 of file kmheaders.cpp.

References KMFolder::unGetMsg().

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

dirties the sort order

Definition at line 2857 of file kmheaders.cpp.

Referenced by msgAdded(), msgRemoved(), and setSorting().

void KMHeaders::rightButtonPressed QListViewItem *  ,
const QPoint &  ,
int 
[protected, slot]
 

show context menu

Definition at line 2328 of file kmheaders.cpp.

References setSelected(), and slotRMB().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.2.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Mar 6 17:18:23 2004 by doxygen 1.3.6-20040222 written by Dimitri van Heesch, © 1997-2003