• Skip to content
• Skip to link menu

KDE 4.2 API Reference

• KDE API Reference
• kdepim

• Sitemap
• Contact Us

 

kmail

KMFolderTree Class Reference

#include <kmfoldertree.h>

Inheritance diagram for KMFolderTree:

[legend]

List of all members.

---

Detailed Description

Definition at line 120 of file kmfoldertree.h.

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	delayedReload ()
void	delayedUpdate ()
void	doFolderSelected (Q3ListViewItem *qlvi, bool keepSelection=false)
void	incCurrentFolder ()
void	nextUnreadFolder ()
void	pasteFolder ()
void	prevUnreadFolder ()
virtual void	reload (bool openFolders=false)
void	selectCurrentFolder ()
void	slotAccountRemoved (KMAccount *)
void	slotResetFolderList (Q3ListViewItem *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, QList< QPointer< 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 *, QMenu *menu, Q3ListViewItem *start=0)
	KMFolderTree (KMMainWidget *mainWidget, QWidget *parent=0, const char *name=0)
void	nextUnreadFolder (bool confirm)
virtual void	readConfig (void)
QList< QPointer< KMFolder > >	selectedFolders ()
void	showFolder (KMFolder *)
void	toggleColumn (int column, bool openFolders=false)
virtual void	updatePopup () const
void	writeConfig ()
Protected Slots
virtual void	copySelectedToFolder (QAction *act)
void	doFolderListChanged ()
virtual void	moveSelectedToFolder (QAction *act)
void	openFolder ()
void	refresh ()
void	slotCheckMail ()
void	slotContextMenuRequested (Q3ListViewItem *, const QPoint &)
void	slotFolderCollapsed (Q3ListViewItem *item)
void	slotFolderExpanded (Q3ListViewItem *item)
void	slotFolderMoveOrCopyOperationFinished ()
void	slotFolderRemoved (KMFolder *)
void	slotNewMessageToMailingList ()
void	slotRenameFolder (Q3ListViewItem *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 Q3DragObject *	dragObject ()
bool	eventFilter (QObject *, QEvent *)
void	moveOrCopyFolder (QList< QPointer< 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
Q3ListViewItem *	dropItem
QPointer< KMFolderTreeItem >	mLastItem
QTimer	mUpdateTimer
Q3ListViewItem *	oldCurrent
Q3ListViewItem *	oldSelected

---

Member Enumeration Documentation

enum KMFolderTree::ColumnMode

Enumerator:

unread
total
foldersize

Definition at line 160 of file kmfoldertree.h.

enum KMFolderTree::MenuAction

Valid actions for the folderToPopup method.

Enumerator:

CopyMessage
MoveMessage
CopyFolder
MoveFolder

Definition at line 173 of file kmfoldertree.h.

---

Constructor & Destructor Documentation

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

Definition at line 380 of file kmfoldertree.cpp.

---

Member Function Documentation

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

Create a child folder.

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

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

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

Definition at line 900 of file kmfoldertree.cpp.

void KMFolderTree::cleanupConfigFile

(

)

Remove information about not existing folders from the config file.

Definition at line 1373 of file kmfoldertree.cpp.

void KMFolderTree::columnsChanged

(

)

[signal]

unread/total/size column has changed

void KMFolderTree::connectSignals

(

)

[protected]

connect all signals

Definition at line 427 of file kmfoldertree.cpp.

void KMFolderTree::contentsDragEnterEvent

(

QDragEnterEvent *

e

)

[protected]

Drag and drop methods.

Definition at line 1429 of file kmfoldertree.cpp.

void KMFolderTree::contentsDragLeaveEvent

(

QDragLeaveEvent *

e

)

[protected]

Definition at line 1495 of file kmfoldertree.cpp.

void KMFolderTree::contentsDragMoveEvent

(

QDragMoveEvent *

e

)

[protected]

Definition at line 1453 of file kmfoldertree.cpp.

void KMFolderTree::contentsDropEvent

(

QDropEvent *

e

)

[protected]

Reimplemented from KMail::FolderTreeBase.

Definition at line 1508 of file kmfoldertree.cpp.

void KMFolderTree::contentsMousePressEvent

(

QMouseEvent *

e

)

[protected, virtual]

Reimplemented from KPIM::KFolderTree.

Definition at line 1214 of file kmfoldertree.cpp.

void KMFolderTree::contentsMouseReleaseEvent

(

QMouseEvent *

me

)

[protected, virtual]

Reimplemented from KPIM::KFolderTree.

Definition at line 1221 of file kmfoldertree.cpp.

void KMFolderTree::copyFolder

(

)

[slot]

Copies the currently selected folder.

Definition at line 2098 of file kmfoldertree.cpp.

void KMFolderTree::copySelectedToFolder

(

QAction *

act

)

[protected, virtual, slot]

For RMB copy folder.

Definition at line 1969 of file kmfoldertree.cpp.

void KMFolderTree::createFolderList	(	QStringList *	str,
		QList< QPointer< 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 1800 of file kmfoldertree.cpp.

KMFolder * KMFolderTree::currentFolder

(

)

const

Definition at line 991 of file kmfoldertree.cpp.

void KMFolderTree::cutFolder

(

)

[slot]

Cuts the currently selected folder.

Definition at line 2108 of file kmfoldertree.cpp.

void KMFolderTree::decCurrentFolder

(

)

[slot]

Decrement current folder.

Definition at line 968 of file kmfoldertree.cpp.

void KMFolderTree::delayedReload

(

)

[slot]

Reload the folder tree (using a single shot timer).

Definition at line 2167 of file kmfoldertree.cpp.

void KMFolderTree::delayedUpdate

(

)

[slot]

Executes delayed update of folder tree.

Definition at line 799 of file kmfoldertree.cpp.

void KMFolderTree::doFolderListChanged

(

)

[protected, slot]

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

Definition at line 822 of file kmfoldertree.cpp.

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

Select the item and switch to the folder.

Definition at line 1016 of file kmfoldertree.cpp.

Q3DragObject * KMFolderTree::dragObject

(

)

[protected, virtual]

Definition at line 2084 of file kmfoldertree.cpp.

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

Definition at line 1763 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,
		QMenu *	menu,
		Q3ListViewItem *	start = 0
	)

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

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

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

Move or copy the folder source to destination.

Definition at line 1975 of file kmfoldertree.cpp.

void KMFolderTree::moveSelectedToFolder

(

QAction *

act

)

[protected, virtual, slot]

For RMB move folder.

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

void KMFolderTree::nextUnreadFolder

(

bool

confirm

)

Select the next folder with unread messages.

Definition at line 877 of file kmfoldertree.cpp.

void KMFolderTree::openFolder

(

)

[protected, slot]

Open a folder.

Definition at line 1417 of file kmfoldertree.cpp.

void KMFolderTree::pasteFolder

(

)

[slot]

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

Definition at line 2118 of file kmfoldertree.cpp.

void KMFolderTree::prepareItem

(

KMFolderTreeItem *

fti

)

[protected]

open ancestors and ensure item is visible

Definition at line 863 of file kmfoldertree.cpp.

void KMFolderTree::prevUnreadFolder

(

)

[slot]

Select the previous folder with unread messages.

Definition at line 943 of file kmfoldertree.cpp.

void KMFolderTree::readConfig

(

void

)

[virtual]

Read config options.

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

void KMFolderTree::refresh

(

)

[protected, slot]

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

Definition at line 792 of file kmfoldertree.cpp.

void KMFolderTree::reload

(

bool

openFolders = false

)

[virtual, slot]

Get/refresh the folder tree.

Definition at line 550 of file kmfoldertree.cpp.

void KMFolderTree::resizeEvent

(

QResizeEvent *

e

)

[protected, virtual]

Definition at line 1051 of file kmfoldertree.cpp.

void KMFolderTree::selectCurrentFolder

(

)

[slot]

Select the current folder.

Definition at line 981 of file kmfoldertree.cpp.

QList< QPointer< KMFolder > > KMFolderTree::selectedFolders

(

)

Definition at line 1000 of file kmfoldertree.cpp.

void KMFolderTree::showFolder

(

KMFolder *

folder

)

Select the folder and make sure it's visible.

Definition at line 1847 of file kmfoldertree.cpp.

void KMFolderTree::slotAccountRemoved

(

KMAccount *

)

[slot]

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

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

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

Definition at line 1061 of file kmfoldertree.cpp.

void KMFolderTree::slotFolderCollapsed

(

Q3ListViewItem *

item

)

[protected, slot]

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

Definition at line 1614 of file kmfoldertree.cpp.

void KMFolderTree::slotFolderExpanded

(

Q3ListViewItem *

item

)

[protected, slot]

Expand an IMAP folder.

Definition at line 1579 of file kmfoldertree.cpp.

void KMFolderTree::slotFolderMoveOrCopyOperationFinished

(

)

[protected, slot]

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

Definition at line 286 of file kmfoldertree.cpp.

void KMFolderTree::slotFolderRemoved

(

KMFolder *

aFolder

)

[protected, slot]

called, when a folder has been deleted

Definition at line 834 of file kmfoldertree.cpp.

void KMFolderTree::slotNewMessageToMailingList

(

)

[protected, slot]

Definition at line 1790 of file kmfoldertree.cpp.

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

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

Definition at line 1624 of file kmfoldertree.cpp.

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

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

Definition at line 1830 of file kmfoldertree.cpp.

void KMFolderTree::slotToggleSizeColumn

(

)

[protected, slot]

Definition at line 1755 of file kmfoldertree.cpp.

void KMFolderTree::slotToggleTotalColumn

(

)

[protected, slot]

Definition at line 1748 of file kmfoldertree.cpp.

void KMFolderTree::slotToggleUnreadColumn

(

)

[protected, slot]

slots for the unread/total/size-popup

Definition at line 1742 of file kmfoldertree.cpp.

void KMFolderTree::slotUpdateCountsDelayed

(

KMFolder *

folder

)

[protected, slot]

Update the total and unread columns but delayed.

Definition at line 1653 of file kmfoldertree.cpp.

void KMFolderTree::slotUpdateCountTimeout

(

)

[protected, slot]

Definition at line 1666 of file kmfoldertree.cpp.

void KMFolderTree::slotUpdateOneCount

(

)

[protected, slot]

Definition at line 689 of file kmfoldertree.cpp.

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

toggles the unread and total columns on/off

Definition at line 1690 of file kmfoldertree.cpp.

void KMFolderTree::updateCopyActions

(

)

[protected, slot]

Updates copy/cut/paste actions.

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

void KMFolderTree::updateUnreadAll

(

)

[protected, virtual]

Updates the number of unread messages for all folders.

Definition at line 522 of file kmfoldertree.cpp.

void KMFolderTree::writeConfig

(

void

)

Save config options.

Definition at line 506 of file kmfoldertree.cpp.

void KMFolderTree::writeIsListViewItemOpen

(

KMFolderTreeItem *

fti

)

[protected]

Definition at line 1349 of file kmfoldertree.cpp.

---

Member Data Documentation

QTimer KMFolderTree::autoopen_timer [protected]

Definition at line 327 of file kmfoldertree.h.

Q3ListViewItem* KMFolderTree::dropItem [protected]

Definition at line 325 of file kmfoldertree.h.

QPointer<KMFolderTreeItem> KMFolderTree::mLastItem [protected]

Definition at line 326 of file kmfoldertree.h.

QTimer KMFolderTree::mUpdateTimer [protected]

Definition at line 314 of file kmfoldertree.h.

Q3ListViewItem* KMFolderTree::oldCurrent [protected]

Drag and drop variables.

Definition at line 324 of file kmfoldertree.h.

Q3ListViewItem * KMFolderTree::oldSelected [protected]

Definition at line 324 of file kmfoldertree.h.

---

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

• kmfoldertree.h
• kmfoldertree.cpp

kmail

Skip menu "kmail"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members
• Related Pages