kmail

KMFolderTree Class Reference

List of all members.

Detailed Description

Definition at line 101 of file kmfoldertree.h.


Public Types

enum  ColumnMode { unread = 15, total = 16 }
enum  MenuAction { CopyMessage, MoveMessage, CopyFolder, MoveFolder }

Public Slots

void nextUnreadFolder ()
void prevUnreadFolder ()
void incCurrentFolder ()
void decCurrentFolder ()
void selectCurrentFolder ()
void delayedUpdate ()
void slotAccountRemoved (KMAccount *)
void doFolderSelected (QListViewItem *qlvi, bool keepSelection=false)
void slotResetFolderList (QListViewItem *item=0, bool startList=true)
void addChildFolder (KMFolder *folder=0, QWidget *parent=0)
void copyFolder ()
void cutFolder ()
void pasteFolder ()

Signals

void folderSelected (KMFolder *)
void folderSelectedUnread (KMFolder *)
void folderDrop (KMFolder *)
void folderDropCopy (KMFolder *)
void columnsChanged ()
void iconChanged (KMFolderTreeItem *)
void nameChanged (KMFolderTreeItem *)

Public Member Functions

 KMFolderTree (KMMainWidget *mainWidget, QWidget *parent=0, const char *name=0)
void writeConfig ()
virtual void reload (bool openFolders=false)
virtual void addDirectory (KMFolderDir *fdir, KMFolderTreeItem *parent)
virtual QListViewItem * indexOfFolder (const KMFolder *folder) const
void createFolderList (QStringList *str, QValueList< QGuardedPtr< KMFolder > > *folders, bool localFolders=true, bool imapFolders=true, bool dimapFolders=true, bool searchFolders=false, bool includeNoContent=true, bool includeNoChildren=true)
virtual void readConfig (void)
void readColorConfig (void)
void cleanupConfigFile ()
void nextUnreadFolder (bool confirm)
bool checkUnreadFolder (KMFolderTreeItem *ftl, bool confirm)
KMFolder * currentFolder () const
QValueList< QGuardedPtr< KMFolder > > selectedFolders ()
void toggleColumn (int column, bool openFolders=false)
virtual void updatePopup () const
KMMainWidget * mainWidget () const
void showFolder (KMFolder *)
void insertIntoFolderToItemMap (const KMFolder *folder, KMFolderTreeItem *item)
void removeFromFolderToItemMap (const KMFolder *folder)
void folderToPopupMenu (MenuAction action, QObject *receiver, KMMenuToFolder *, QPopupMenu *menu, QListViewItem *start=0)

Protected Slots

void doFolderListChanged ()
void slotFolderRemoved (KMFolder *)
void refresh ()
void openFolder ()
void slotFolderExpanded (QListViewItem *item)
void slotFolderCollapsed (QListViewItem *item)
void slotRenameFolder (QListViewItem *item, int col, const QString &text)
void slotUpdateCounts (KMFolder *folder)
void slotUpdateCounts (KMFolderImap *folder, bool success=true)
void slotUpdateCountsDelayed (KMFolder *folder)
void slotUpdateCountTimeout ()
void slotUpdateOneCount ()
void slotToggleUnreadColumn ()
void slotToggleTotalColumn ()
void slotContextMenuRequested (QListViewItem *, const QPoint &)
void slotCheckMail ()
void slotNewMessageToMailingList ()
virtual void moveSelectedToFolder (int menuId)
virtual void copySelectedToFolder (int menuId)
void updateCopyActions ()

Protected Member Functions

virtual bool event (QEvent *e)
virtual void contentsMousePressEvent (QMouseEvent *e)
virtual void contentsMouseReleaseEvent (QMouseEvent *me)
virtual void updateUnreadAll ()
virtual void resizeEvent (QResizeEvent *)
bool readIsListViewItemOpen (KMFolderTreeItem *fti)
void writeIsListViewItemOpen (KMFolderTreeItem *fti)
void contentsDragEnterEvent (QDragEnterEvent *e)
void contentsDragMoveEvent (QDragMoveEvent *e)
void contentsDragLeaveEvent (QDragLeaveEvent *e)
void contentsDropEvent (QDropEvent *e)
virtual QDragObject * dragObject ()
bool eventFilter (QObject *, QEvent *)
void prepareItem (KMFolderTreeItem *)
void connectSignals ()
void moveOrCopyFolder (QValueList< QGuardedPtr< KMFolder > > sources, KMFolder *destination, bool move=false)

Protected Attributes

QTimer mUpdateTimer
QListViewItem * oldCurrent
QListViewItem * oldSelected
QListViewItem * dropItem
KMFolderTreeItem * mLastItem
QTimer autoopen_timer

Member Enumeration Documentation

enum KMFolderTree::MenuAction

Valid actions for the folderToPopup method.

Definition at line 182 of file kmfoldertree.h.

Member Function Documentation

void KMFolderTree::writeConfig (  ) 

Save config options.

Definition at line 482 of file kmfoldertree.cpp.

void KMFolderTree::reload ( bool  openFolders = false  )  [virtual]

Get/refresh the folder tree.

Definition at line 526 of file kmfoldertree.cpp.

void KMFolderTree::addDirectory ( KMFolderDir *  fdir,
KMFolderTreeItem *  parent 
) [virtual]

Recusively add folders in a folder directory to a listview item.

Definition at line 684 of file kmfoldertree.cpp.

virtual QListViewItem* KMFolderTree::indexOfFolder ( const KMFolder *  folder  )  const [inline, virtual]

Find index of given folder.

Returns 0 if not found

Definition at line 119 of file kmfoldertree.h.

void KMFolderTree::createFolderList ( QStringList *  str,
QValueList< QGuardedPtr< KMFolder > > *  folders,
bool  localFolders = true,
bool  imapFolders = true,
bool  dimapFolders = true,
bool  searchFolders = false,
bool  includeNoContent = true,
bool  includeNoChildren = true 
)

create a folderlist

Definition at line 1760 of file kmfoldertree.cpp.

void KMFolderTree::readConfig ( void   )  [virtual]

Read config options.

Definition at line 459 of file kmfoldertree.cpp.

void KMFolderTree::readColorConfig ( void   ) 

Read color options and set palette.

Definition at line 433 of file kmfoldertree.cpp.

void KMFolderTree::cleanupConfigFile (  ) 

Remove information about not existing folders from the config file.

Definition at line 1303 of file kmfoldertree.cpp.

void KMFolderTree::nextUnreadFolder ( bool  confirm  ) 

Select the next folder with unread messages.

Definition at line 810 of file kmfoldertree.cpp.

bool KMFolderTree::checkUnreadFolder ( KMFolderTreeItem *  ftl,
bool  confirm 
)

Check folder for unread messages (which isn't trash).

Definition at line 833 of file kmfoldertree.cpp.

void KMFolderTree::toggleColumn ( int  column,
bool  openFolders = false 
)

toggles the unread and total columns on/off

Definition at line 1674 of file kmfoldertree.cpp.

void KMFolderTree::updatePopup (  )  const [virtual]

Set the checked/unchecked state of the unread and total column in the popup correctly.

Definition at line 1667 of file kmfoldertree.cpp.

KMMainWidget* KMFolderTree::mainWidget (  )  const [inline]

Returns the main widget that this widget is a child of.

Definition at line 166 of file kmfoldertree.h.

void KMFolderTree::showFolder ( KMFolder *   ) 

Select the folder and make sure it's visible.

Definition at line 1807 of file kmfoldertree.cpp.

void KMFolderTree::folderToPopupMenu ( MenuAction  action,
QObject *  receiver,
KMMenuToFolder *  ,
QPopupMenu *  menu,
QListViewItem *  start = 0 
)

Generate a popup menu that contains all folders that can have content.

Definition at line 1819 of file kmfoldertree.cpp.

void KMFolderTree::folderSelected ( KMFolder *   )  [signal]

The selected folder has changed.

void KMFolderTree::folderSelectedUnread ( KMFolder *   )  [signal]

The selected folder has changed to go to an unread message.

void KMFolderTree::folderDrop ( KMFolder *   )  [signal]

Messages have been dropped onto a folder.

void KMFolderTree::folderDropCopy ( KMFolder *   )  [signal]

Messages have been dropped onto a folder with Ctrl.

void KMFolderTree::columnsChanged (  )  [signal]

unread/total column has changed

void KMFolderTree::iconChanged ( KMFolderTreeItem *   )  [signal]

an icon of one of our folders changed

void KMFolderTree::nameChanged ( KMFolderTreeItem *   )  [signal]

the name of one of our folders changed

void KMFolderTree::nextUnreadFolder (  )  [slot]

Select the next folder with unread messages.

Definition at line 804 of file kmfoldertree.cpp.

void KMFolderTree::prevUnreadFolder (  )  [slot]

Select the previous folder with unread messages.

Definition at line 876 of file kmfoldertree.cpp.

void KMFolderTree::incCurrentFolder (  )  [slot]

Increment current folder.

Definition at line 888 of file kmfoldertree.cpp.

void KMFolderTree::decCurrentFolder (  )  [slot]

Decrement current folder.

Definition at line 901 of file kmfoldertree.cpp.

void KMFolderTree::selectCurrentFolder (  )  [slot]

Select the current folder.

Definition at line 914 of file kmfoldertree.cpp.

void KMFolderTree::delayedUpdate (  )  [slot]

Executes delayed update of folder tree.

Definition at line 743 of file kmfoldertree.cpp.

void KMFolderTree::slotAccountRemoved ( KMAccount *   )  [slot]

Make sure the given account is not selected because it is gone.

Definition at line 772 of file kmfoldertree.cpp.

void KMFolderTree::doFolderSelected ( QListViewItem *  qlvi,
bool  keepSelection = false 
) [slot]

Select the item and switch to the folder.

Definition at line 949 of file kmfoldertree.cpp.

void KMFolderTree::slotResetFolderList ( QListViewItem *  item = 0,
bool  startList = true 
) [slot]

Reset current folder and all childs If no item is given we take the current one If startListing is true a folder listing is started.

Definition at line 1790 of file kmfoldertree.cpp.

void KMFolderTree::addChildFolder ( KMFolder *  folder = 0,
QWidget *  parent = 0 
) [slot]

Create a child folder.

Definition at line 1196 of file kmfoldertree.cpp.

void KMFolderTree::copyFolder (  )  [slot]

Copies the currently selected folder.

Definition at line 2053 of file kmfoldertree.cpp.

void KMFolderTree::cutFolder (  )  [slot]

Cuts the currently selected folder.

Definition at line 2063 of file kmfoldertree.cpp.

void KMFolderTree::pasteFolder (  )  [slot]

Pastes a previously copied/cutted folder below the currently selected folder.

Definition at line 2073 of file kmfoldertree.cpp.

void KMFolderTree::doFolderListChanged (  )  [protected, slot]

called by the folder-manager when the list of folders changed

Definition at line 766 of file kmfoldertree.cpp.

void KMFolderTree::slotFolderRemoved ( KMFolder *   )  [protected, slot]

called, when a folder has been deleted

Definition at line 778 of file kmfoldertree.cpp.

void KMFolderTree::refresh (  )  [protected, slot]

Updates the folder tree (delayed), causing a "blink".

Definition at line 736 of file kmfoldertree.cpp.

void KMFolderTree::openFolder (  )  [protected, slot]

Open a folder.

Definition at line 1352 of file kmfoldertree.cpp.

void KMFolderTree::slotFolderExpanded ( QListViewItem *  item  )  [protected, slot]

Expand an IMAP folder.

Definition at line 1510 of file kmfoldertree.cpp.

void KMFolderTree::slotFolderCollapsed ( QListViewItem *  item  )  [protected, slot]

Tell the folder to refresh the contents on the next expansion.

Definition at line 1543 of file kmfoldertree.cpp.

void KMFolderTree::slotRenameFolder ( QListViewItem *  item,
int  col,
const QString &  text 
) [protected, slot]

Check if the new name is valid and confirm the new name.

Definition at line 1549 of file kmfoldertree.cpp.

void KMFolderTree::slotUpdateCounts ( KMFolder *  folder  )  [protected, slot]

Update the total and unread columns (if available).

Definition at line 1613 of file kmfoldertree.cpp.

void KMFolderTree::slotUpdateCountsDelayed ( KMFolder *  folder  )  [protected, slot]

Update the total and unread columns but delayed.

Definition at line 1584 of file kmfoldertree.cpp.

void KMFolderTree::slotToggleUnreadColumn (  )  [protected, slot]

slots for the unread/total-popup

Definition at line 1710 of file kmfoldertree.cpp.

void KMFolderTree::slotCheckMail (  )  [protected, slot]

Fires a new-mail-check of the account that is accociated with currentItem.

Definition at line 1736 of file kmfoldertree.cpp.

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

For RMB move folder.

Definition at line 1924 of file kmfoldertree.cpp.

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

For RMB copy folder.

Definition at line 1930 of file kmfoldertree.cpp.

void KMFolderTree::updateCopyActions (  )  [protected, slot]

Updates copy/cut/paste actions.

Definition at line 2084 of file kmfoldertree.cpp.

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

Catch palette changes.

Definition at line 422 of file kmfoldertree.cpp.

void KMFolderTree::updateUnreadAll (  )  [protected, virtual]

Updates the number of unread messages for all folders.

Definition at line 498 of file kmfoldertree.cpp.

bool KMFolderTree::readIsListViewItemOpen ( KMFolderTreeItem *  fti  )  [protected]

Read/Save open/close state indicator for an item in folderTree list view.

Definition at line 1252 of file kmfoldertree.cpp.

void KMFolderTree::contentsDragEnterEvent ( QDragEnterEvent *  e  )  [protected]

Drag and drop methods.

Definition at line 1364 of file kmfoldertree.cpp.

void KMFolderTree::prepareItem ( KMFolderTreeItem *   )  [protected]

open ancestors and ensure item is visible

Definition at line 796 of file kmfoldertree.cpp.

void KMFolderTree::connectSignals (  )  [protected]

connect all signals

Definition at line 368 of file kmfoldertree.cpp.

void KMFolderTree::moveOrCopyFolder ( QValueList< QGuardedPtr< KMFolder > >  sources,
KMFolder *  destination,
bool  move = false 
) [protected]

Move or copy the folder source to destination.

Definition at line 1936 of file kmfoldertree.cpp.

Member Data Documentation

QListViewItem* KMFolderTree::oldCurrent [protected]

Drag and drop variables.

Definition at line 335 of file kmfoldertree.h.

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

kmail

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys