KDE PIM / Developers / API Docs / kmail

KMHeaders Class Reference

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

#include <kmheaders.h>

Inherits KListView.

List of all members.

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Slots

Protected Member Functions

Static Protected Attributes

Friends


Detailed Description

The widget that shows the contents of folders.


Member Function Documentation

void KMHeaders::setFolder KMFolder ,
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.

KMFolder* KMHeaders::folder void   )  [inline]
 

Return the folder whose message headers are being displayed.

void KMHeaders::refreshNestedState void   ) 
 

read the config file and update nested state if necessary

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.

QPtrList< QListViewItem > KMHeaders::currentThread  )  const
 

Get a list of all items in the current thread.

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

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

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

The following methods processes all selected messages.

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 usefull when the user has already confirmed the move/deletion.

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.

void KMHeaders::clearSelectableAndAboutToBeDeleted Q_UINT32  serNum  )  [virtual]
 

Resets toBeDeleted and selectable status of all selected items.

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

Returns list of selected messages.

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

QValueList< int > KMHeaders::selectedItems  ) 
 

Returns the index values of currently selected items.

int KMHeaders::indexOfGetMsg void   )  const [inline]
 

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

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

Returns pointer to owning main window.

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

PaintInfo pointer.

void KMHeaders::readConfig void   )  [virtual]
 

Read config options.

void KMHeaders::readColorConfig void   )  [virtual]
 

Read color options and set palette.

void KMHeaders::reset void   )  [virtual]
 

Refresh the list of message headers shown.

void KMHeaders::showNewMail  ) 
 

Scroll to show new mail.

KMMessage * KMHeaders::currentMsg  )  [virtual]
 

Return the current message.

HeaderItem * KMHeaders::currentHeaderItem  )  [virtual]
 

Return the current list view item.

int KMHeaders::currentItemIndex  )  [virtual]
 

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

void KMHeaders::setCurrentItemByIndex int  msgIdx  )  [virtual]
 

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

void KMHeaders::setCurrentItemBySerialNum unsigned long  serialNum  ) 
 

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

int KMHeaders::topItemIndex  )  [virtual]
 

Return the message id of the top most visible item.

void KMHeaders::setTopItemByIndex int  aMsgIdx  )  [virtual]
 

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

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

Double force items to always be open.

bool KMHeaders::isThreaded  )  const [inline]
 

Returns true if the current header list is threaded.

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.

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

return a string relativ to the current time

const KMMsgBase * KMHeaders::getMsgBaseForItem const QListViewItem *  item  )  const
 

gets the message represented by the item as a KMMsgBase.

void KMHeaders::selected KMMessage *   )  [signal]
 

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

void KMHeaders::activated KMMessage *   )  [signal]
 

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

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::msgAddedToListView QListViewItem *   )  [signal]
 

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

We can't use KListView::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::selectMessage QListViewItem *   )  [slot]
 

For when a list view item has been double clicked.

void KMHeaders::highlightMessage QListViewItem *   )  [slot]
 

For when a list view item has been selected.

void KMHeaders::slotRMB  )  [slot]
 

For when righ mouse button is pressed.

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

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

void KMHeaders::msgChanged  )  [slot]
 

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

void KMHeaders::folderCleared  )  [slot]
 

For when the folder has been cleared.

void KMHeaders::msgAdded int   )  [slot]
 

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

void KMHeaders::msgRemoved int  ,
QString 
[slot]
 

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

void KMHeaders::nextMessage  )  [slot]
 

Make the next header visible scrolling if necessary.

void KMHeaders::selectNextMessage  )  [slot]
 

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

void KMHeaders::prevMessage  )  [slot]
 

Make the previous header visible scrolling if necessary.

void KMHeaders::selectPrevMessage  )  [slot]
 

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

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

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

bool KMHeaders::prevUnreadMessage  )  [slot]
 

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

void KMHeaders::incCurrentMessage  )  [slot]
 

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

void KMHeaders::decCurrentMessage  )  [slot]
 

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

void KMHeaders::selectCurrentMessage  )  [slot]
 

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

void KMHeaders::slotNoDrag  )  [slot]
 

Don't show a drag cursor.

void KMHeaders::resetCurrentTime  )  [slot]
 

timer function to set the current time regularly

void KMHeaders::slotExpandOrCollapseThread bool  expand  )  [slot]
 

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

void KMHeaders::slotExpandOrCollapseAllThreads bool  expand  )  [slot]
 

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

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.

void KMHeaders::setSelectedByIndex QValueList< int >  items,
bool  selected
[slot]
 

Select several items by message index and if they are the parent of a closed thread, also recursively select their children.

void KMHeaders::slotToggleColumn int  id,
int  mode = -1
[slot]
 

switch a column with the given id (see KPaintInfo enum) 1 for activate, 0 for deactivate, -1 for toggle

void KMHeaders::setFolderInfoStatus  )  [slot]
 

Provide information about number of messages in a folder.

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

Look for color changes.

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

Overridden to support backing pixmap.

void KMHeaders::makeHeaderVisible  )  [protected]
 

Ensure the current item is visible.

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

Auxillary method to 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.

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

Read per-folder config options and apply them.

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

Write per-folder config options.

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

Write global config options.

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

Handle shift and control selection.

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

Called when a header is clicked.

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

To initiate a drag operation.

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

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

void KMHeaders::setStyleDependantFrameWidth  )  [protected]
 

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

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

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

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

Same thing but copy.

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

Apply the filter Rules to a single message.

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

dirties the sort order

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

show context menu


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