KMFolderTree Class Reference

#include <kmfoldertree.h>

Inheritance diagram for KMFolderTree:

[legend]

List of all members.

Public Types
enum	ColumnMode { unread = 15, total = 16, foldersize = 17 }
enum	MenuAction { CopyMessage, MoveMessage, CopyFolder, MoveFolder }
Public Slots
void	addChildFolder (KMFolder *folder=0, QWidget *parent=0)
void	copyFolder ()
void	cutFolder ()
void	decCurrentFolder ()
void	delayedUpdate ()
void	doFolderSelected (QListViewItem *qlvi, bool keepSelection=false)
void	incCurrentFolder ()
void	nextUnreadFolder ()
void	pasteFolder ()
void	prevUnreadFolder ()
void	selectCurrentFolder ()
void	slotAccountRemoved (KMAccount *)
void	slotResetFolderList (QListViewItem *item=0, bool startList=true)
Signals
void	columnsChanged ()
void	folderSelected (KMFolder *)
void	folderSelectedUnread (KMFolder *)
void	iconChanged (KMFolderTreeItem *)
void	nameChanged (KMFolderTreeItem *)
Public Member Functions
virtual void	addDirectory (KMFolderDir *fdir, KMFolderTreeItem *parent)
bool	checkUnreadFolder (KMFolderTreeItem *ftl, bool confirm)
void	cleanupConfigFile ()
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)
KMFolder *	currentFolder () const
void	folderToPopupMenu (MenuAction action, QObject *receiver, KMMenuToFolder *, QPopupMenu *menu, QListViewItem *start=0)
	KMFolderTree (KMMainWidget *mainWidget, QWidget *parent=0, const char *name=0)
void	nextUnreadFolder (bool confirm)
virtual void	readConfig (void)
virtual void	reload (bool openFolders=false)
QValueList< QGuardedPtr < KMFolder > >	selectedFolders ()
void	showFolder (KMFolder *)
void	toggleColumn (int column, bool openFolders=false)
virtual void	updatePopup () const
void	writeConfig ()
Protected Slots
virtual void	copySelectedToFolder (int menuId)
void	doFolderListChanged ()
virtual void	moveSelectedToFolder (int menuId)
void	openFolder ()
void	refresh ()
void	slotCheckMail ()
void	slotContextMenuRequested (QListViewItem *, const QPoint &)
void	slotFolderCollapsed (QListViewItem *item)
void	slotFolderExpanded (QListViewItem *item)
void	slotFolderMoveOrCopyOperationFinished ()
void	slotFolderRemoved (KMFolder *)
void	slotNewMessageToMailingList ()
void	slotRenameFolder (QListViewItem *item, int col, const QString &text)
void	slotToggleSizeColumn ()
void	slotToggleTotalColumn ()
void	slotToggleUnreadColumn ()
void	slotUpdateCountsDelayed (KMFolder *folder)
void	slotUpdateCountTimeout ()
void	slotUpdateOneCount ()
void	updateCopyActions ()
Protected Member Functions
void	connectSignals ()
void	contentsDragEnterEvent (QDragEnterEvent *e)
void	contentsDragLeaveEvent (QDragLeaveEvent *e)
void	contentsDragMoveEvent (QDragMoveEvent *e)
void	contentsDropEvent (QDropEvent *e)
virtual void	contentsMousePressEvent (QMouseEvent *e)
virtual void	contentsMouseReleaseEvent (QMouseEvent *me)
virtual QDragObject *	dragObject ()
bool	eventFilter (QObject *, QEvent *)
void	moveOrCopyFolder (QValueList< QGuardedPtr< KMFolder > > sources, KMFolder *destination, bool move=false)
void	prepareItem (KMFolderTreeItem *)
bool	readIsListViewItemOpen (KMFolderTreeItem *fti)
virtual void	resizeEvent (QResizeEvent *)
virtual void	updateUnreadAll ()
void	writeIsListViewItemOpen (KMFolderTreeItem *fti)
Protected Attributes
QTimer	autoopen_timer
QListViewItem *	dropItem
KMFolderTreeItem *	mLastItem
QTimer	mUpdateTimer
QListViewItem *	oldCurrent
QListViewItem *	oldSelected

---

Detailed Description

Definition at line 107 of file kmfoldertree.h.

---

Member Enumeration Documentation

enum KMFolderTree::ColumnMode

Enumerator:

unread
total
foldersize

Definition at line 150 of file kmfoldertree.h.

enum KMFolderTree::MenuAction

Valid actions for the folderToPopup method.

Enumerator:

CopyMessage
MoveMessage
CopyFolder
MoveFolder

Definition at line 163 of file kmfoldertree.h.

---

Constructor & Destructor Documentation

KMFolderTree::KMFolderTree	(	KMMainWidget *	mainWidget,
		QWidget *	parent = 0,
		const char *	name = 0
	)

Definition at line 356 of file kmfoldertree.cpp.

---

Member Function Documentation

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

Create a child folder.

Definition at line 1231 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.

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

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

Definition at line 863 of file kmfoldertree.cpp.

void KMFolderTree::cleanupConfigFile

(

)

Remove information about not existing folders from the config file.

Definition at line 1338 of file kmfoldertree.cpp.

void KMFolderTree::columnsChanged

(

)

[signal]

unread/total/size column has changed

void KMFolderTree::connectSignals

(

)

[protected]

connect all signals

Definition at line 400 of file kmfoldertree.cpp.

void KMFolderTree::contentsDragEnterEvent

(

QDragEnterEvent *

e

)

[protected]

Drag and drop methods.

Definition at line 1394 of file kmfoldertree.cpp.

void KMFolderTree::contentsDragLeaveEvent

(

QDragLeaveEvent *

e

)

[protected]

Definition at line 1460 of file kmfoldertree.cpp.

void KMFolderTree::contentsDragMoveEvent

(

QDragMoveEvent *

e

)

[protected]

Definition at line 1418 of file kmfoldertree.cpp.

void KMFolderTree::contentsDropEvent

(

QDropEvent *

e

)

[protected]

Reimplemented from KMail::FolderTreeBase.

Definition at line 1473 of file kmfoldertree.cpp.

void KMFolderTree::contentsMousePressEvent

(

QMouseEvent *

e

)

[protected, virtual]

Definition at line 1177 of file kmfoldertree.cpp.

void KMFolderTree::contentsMouseReleaseEvent

(

QMouseEvent *

me

)

[protected, virtual]

Definition at line 1184 of file kmfoldertree.cpp.

void KMFolderTree::copyFolder

(

)

[slot]

Copies the currently selected folder.

Definition at line 2057 of file kmfoldertree.cpp.

void KMFolderTree::copySelectedToFolder

(

int

menuId

)

[protected, virtual, slot]

For RMB copy folder.

Definition at line 1925 of file kmfoldertree.cpp.

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 1755 of file kmfoldertree.cpp.

KMFolder * KMFolderTree::currentFolder

(

)

const

Definition at line 954 of file kmfoldertree.cpp.

void KMFolderTree::cutFolder

(

)

[slot]

Cuts the currently selected folder.

Definition at line 2067 of file kmfoldertree.cpp.

void KMFolderTree::decCurrentFolder

(

)

[slot]

Decrement current folder.

Definition at line 931 of file kmfoldertree.cpp.

void KMFolderTree::delayedUpdate

(

)

[slot]

Executes delayed update of folder tree.

Definition at line 758 of file kmfoldertree.cpp.

void KMFolderTree::doFolderListChanged

(

)

[protected, slot]

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

Definition at line 781 of file kmfoldertree.cpp.

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

Select the item and switch to the folder.

Definition at line 979 of file kmfoldertree.cpp.

QDragObject * KMFolderTree::dragObject

(

)

[protected, virtual]

Definition at line 2043 of file kmfoldertree.cpp.

bool KMFolderTree::eventFilter	(	QObject *	o,
		QEvent *	e
	)			[protected]

Definition at line 1718 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::folderToPopupMenu	(	MenuAction	action,
		QObject *	receiver,
		KMMenuToFolder *	aMenuToFolder,
		QPopupMenu *	menu,
		QListViewItem *	start = 0
	)

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

Definition at line 1814 of file kmfoldertree.cpp.

void KMFolderTree::iconChanged

(

KMFolderTreeItem *

)

[signal]

an icon of one of our folders changed

void KMFolderTree::incCurrentFolder

(

)

[slot]

Increment current folder.

Definition at line 918 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 1931 of file kmfoldertree.cpp.

void KMFolderTree::moveSelectedToFolder

(

int

menuId

)

[protected, virtual, slot]

For RMB move folder.

Definition at line 1919 of file kmfoldertree.cpp.

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 834 of file kmfoldertree.cpp.

void KMFolderTree::nextUnreadFolder

(

bool

confirm

)

Select the next folder with unread messages.

Definition at line 840 of file kmfoldertree.cpp.

void KMFolderTree::openFolder

(

)

[protected, slot]

Open a folder.

Definition at line 1382 of file kmfoldertree.cpp.

void KMFolderTree::pasteFolder

(

)

[slot]

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

Definition at line 2077 of file kmfoldertree.cpp.

void KMFolderTree::prepareItem

(

KMFolderTreeItem *

fti

)

[protected]

open ancestors and ensure item is visible

Definition at line 826 of file kmfoldertree.cpp.

void KMFolderTree::prevUnreadFolder

(

)

[slot]

Select the previous folder with unread messages.

Definition at line 906 of file kmfoldertree.cpp.

void KMFolderTree::readConfig

(

void

)

[virtual]

Read config options.

Definition at line 460 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 1287 of file kmfoldertree.cpp.

void KMFolderTree::refresh

(

)

[protected, slot]

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

Definition at line 751 of file kmfoldertree.cpp.

void KMFolderTree::reload

(

bool

openFolders = false

)

[virtual]

Get/refresh the folder tree.

Definition at line 527 of file kmfoldertree.cpp.

void KMFolderTree::resizeEvent

(

QResizeEvent *

e

)

[protected, virtual]

Definition at line 1014 of file kmfoldertree.cpp.

void KMFolderTree::selectCurrentFolder

(

)

[slot]

Select the current folder.

Definition at line 944 of file kmfoldertree.cpp.

QValueList< QGuardedPtr< KMFolder > > KMFolderTree::selectedFolders

(

)

Definition at line 963 of file kmfoldertree.cpp.

void KMFolderTree::showFolder

(

KMFolder *

folder

)

Select the folder and make sure it's visible.

Definition at line 1802 of file kmfoldertree.cpp.

void KMFolderTree::slotAccountRemoved

(

KMAccount *

)

[slot]

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

Definition at line 787 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 1731 of file kmfoldertree.cpp.

void KMFolderTree::slotContextMenuRequested	(	QListViewItem *	lvi,
		const QPoint &	p
	)			[protected, slot]

Definition at line 1026 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 1574 of file kmfoldertree.cpp.

void KMFolderTree::slotFolderExpanded

(

QListViewItem *

item

)

[protected, slot]

Expand an IMAP folder.

Definition at line 1539 of file kmfoldertree.cpp.

void KMFolderTree::slotFolderMoveOrCopyOperationFinished

(

)

[protected, slot]

called, when a folder has been moved or copied, successfully or not

Definition at line 793 of file kmfoldertree.cpp.

void KMFolderTree::slotFolderRemoved

(

KMFolder *

aFolder

)

[protected, slot]

called, when a folder has been deleted

Definition at line 798 of file kmfoldertree.cpp.

void KMFolderTree::slotNewMessageToMailingList

(

)

[protected, slot]

Definition at line 1745 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 1584 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 1785 of file kmfoldertree.cpp.

void KMFolderTree::slotToggleSizeColumn

(

)

[protected, slot]

Definition at line 1710 of file kmfoldertree.cpp.

void KMFolderTree::slotToggleTotalColumn

(

)

[protected, slot]

Definition at line 1703 of file kmfoldertree.cpp.

void KMFolderTree::slotToggleUnreadColumn

(

)

[protected, slot]

slots for the unread/total/size-popup

Definition at line 1697 of file kmfoldertree.cpp.

void KMFolderTree::slotUpdateCountsDelayed

(

KMFolder *

folder

)

[protected, slot]

Update the total and unread columns but delayed.

Definition at line 1613 of file kmfoldertree.cpp.

void KMFolderTree::slotUpdateCountTimeout

(

)

[protected, slot]

Definition at line 1626 of file kmfoldertree.cpp.

void KMFolderTree::slotUpdateOneCount

(

)

[protected, slot]

Definition at line 661 of file kmfoldertree.cpp.

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

toggles the unread and total columns on/off

Definition at line 1650 of file kmfoldertree.cpp.

void KMFolderTree::updateCopyActions

(

)

[protected, slot]

Updates copy/cut/paste actions.

Definition at line 2088 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 1642 of file kmfoldertree.cpp.

void KMFolderTree::updateUnreadAll

(

)

[protected, virtual]

Updates the number of unread messages for all folders.

Definition at line 499 of file kmfoldertree.cpp.

void KMFolderTree::writeConfig

(

void

)

Save config options.

Definition at line 483 of file kmfoldertree.cpp.

void KMFolderTree::writeIsListViewItemOpen

(

KMFolderTreeItem *

fti

)

[protected]

Definition at line 1313 of file kmfoldertree.cpp.

---

Member Data Documentation

QTimer KMFolderTree::autoopen_timer [protected]

Definition at line 311 of file kmfoldertree.h.

QListViewItem* KMFolderTree::dropItem [protected]

Definition at line 309 of file kmfoldertree.h.

KMFolderTreeItem* KMFolderTree::mLastItem [protected]

Definition at line 310 of file kmfoldertree.h.

QTimer KMFolderTree::mUpdateTimer [protected]

Definition at line 298 of file kmfoldertree.h.

QListViewItem* KMFolderTree::oldCurrent [protected]

Drag and drop variables.

Definition at line 308 of file kmfoldertree.h.

QListViewItem * KMFolderTree::oldSelected [protected]

Definition at line 308 of file kmfoldertree.h.

---

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

• kmfoldertree.h
• kmfoldertree.cpp