KMail::SearchWindow Class Reference

The SearchWindow class provides a dialog for triggering a search on folders and storing that search as a search folder. More...

#include <searchwindow.h>

Inheritance diagram for KMail::SearchWindow:

[legend]

List of all members.

Public Member Functions
void	activateFolder (KMFolder *curFolder)
KMMessage *	message ()
	SearchWindow (KMMainWidget *parent, const char *name=0, KMFolder *curFolder=0, bool modal=false)
KMMessageList	selectedMessages ()
void	setSearchPattern (const KMSearchPattern &pattern)
virtual	~SearchWindow ()
Protected Slots
virtual void	copySelectedToFolder (int menuId)
void	enableGUI ()
void	folderInvalidated (KMFolder *)
virtual void	moveSelectedToFolder (int menuId)
void	openSearchFolder ()
void	renameSearchFolder ()
void	scheduleRename (const QString &)
virtual void	searchDone ()
void	setEnabledSearchButton (bool)
virtual void	slotAddMsg (int idx)
void	slotClearSelection ()
virtual void	slotClose ()
virtual void	slotContextMenuRequested (QListViewItem *, const QPoint &, int)
void	slotCopyMsgs ()
void	slotCurrentChanged (QListViewItem *)
void	slotCutMsgs ()
virtual void	slotFolderActivated ()
void	slotForwardAttachedMsg ()
void	slotForwardDigestMsg ()
void	slotForwardInlineMsg ()
void	slotPrintMsg ()
void	slotRedirectMsg ()
virtual void	slotRemoveMsg (KMFolder *, Q_UINT32 serNum)
void	slotReplyAllToMsg ()
void	slotReplyListToMsg ()
void	slotReplyToMsg ()
void	slotSaveAttachments ()
void	slotSaveMsg ()
virtual void	slotSearch ()
virtual bool	slotShowMsg (QListViewItem *)
void	slotShowSelectedMsg ()
virtual void	slotStop ()
virtual void	updateContextMenuActions ()
virtual void	updStatus (void)
Protected Member Functions
virtual void	closeEvent (QCloseEvent *)
virtual void	keyPressEvent (QKeyEvent *)
Protected Attributes
QPushButton *	mBtnSearch
QPushButton *	mBtnStop
KMail::FolderRequester *	mCbxFolders
QRadioButton *	mChkbxAllFolders
QRadioButton *	mChkbxSpecificFolders
QCheckBox *	mChkSubFolders
KAction *	mClearAction
bool	mCloseRequested
KAction *	mCopyAction
KAction *	mCutAction
int	mFetchingInProgress
QGuardedPtr< KMFolderSearch >	mFolder
QValueList< QGuardedPtr < KMFolder > >	mFolders
KActionMenu *	mForwardActionMenu
KAction *	mForwardAttachedAction
KAction *	mForwardDigestAction
KAction *	mForwardInlineAction
KMMainWidget *	mKMMainWidget
QWidget *	mLastFocus
KListView *	mLbxMatches
QMap< int, KMFolder * >	mMenuToFolder
KMSearchPatternEdit *	mPatternEdit
KAction *	mPrintAction
KAction *	mRedirectAction
QTimer	mRenameTimer
KAction *	mReplyAction
KAction *	mReplyAllAction
KAction *	mReplyListAction
KAction *	mSaveAsAction
KAction *	mSaveAtchAction
QLineEdit *	mSearchFolderEdt
QLabel *	mSearchFolderLbl
QPushButton *	mSearchFolderOpenBtn
KMSearchPattern *	mSearchPattern
QPushButton *	mSearchResultOpenBtn
int	mSortColumn
SortOrder	mSortOrder
KStatusBar *	mStatusBar
bool	mStopped
QTimer *	mTimer
Static Protected Attributes
static const int	MSGID_COLUMN = 4

---

Detailed Description

The SearchWindow class provides a dialog for triggering a search on folders and storing that search as a search folder.

It shows the search results in a listview and allows triggering of operations such as printing or moving on them.

Definition at line 68 of file searchwindow.h.

---

Constructor & Destructor Documentation

KMail::SearchWindow::SearchWindow	(	KMMainWidget *	parent,
		const char *	name = 0,
		KMFolder *	curFolder = 0,
		bool	modal = false
	)

Creates a new search window.

Parameters:

	parent	The parent widget.
	name	The (widget) name of the dialog.
	curFolder	The folder which will be pre-selected as the base folder of search operations.
	modal	Whether the dialog is to be shown modal.

Definition at line 109 of file searchwindow.cpp.

KMail::SearchWindow::~SearchWindow

(

)

[virtual]

Definition at line 372 of file searchwindow.cpp.

---

Member Function Documentation

void KMail::SearchWindow::activateFolder

(

KMFolder *

curFolder

)

Changes the base folder for search operations to a different folder.

Parameters:

curFolder

The folder to use as the new base for searches.

Definition at line 459 of file searchwindow.cpp.

void KMail::SearchWindow::closeEvent

(

QCloseEvent *

e

)

[protected, virtual]

Reimplemented to stop searching when the window is closed.

Definition at line 617 of file searchwindow.cpp.

void KMail::SearchWindow::copySelectedToFolder

(

int

menuId

)

[protected, virtual, slot]

Definition at line 778 of file searchwindow.cpp.

void KMail::SearchWindow::enableGUI

(

)

[protected, slot]

Definition at line 718 of file searchwindow.cpp.

void KMail::SearchWindow::folderInvalidated

(

KMFolder *

folder

)

[protected, slot]

Definition at line 670 of file searchwindow.cpp.

void KMail::SearchWindow::keyPressEvent

(

QKeyEvent *

evt

)

[protected, virtual]

Reimplemented to react to Escape.

Definition at line 439 of file searchwindow.cpp.

KMMessage * KMail::SearchWindow::message

(

)

Provides access to the currently selected message.

Returns:

the currently selected message.

Definition at line 750 of file searchwindow.cpp.

void KMail::SearchWindow::moveSelectedToFolder

(

int

menuId

)

[protected, virtual, slot]

Definition at line 766 of file searchwindow.cpp.

void KMail::SearchWindow::openSearchFolder

(

)

[protected, slot]

Definition at line 662 of file searchwindow.cpp.

void KMail::SearchWindow::renameSearchFolder

(

)

[protected, slot]

Definition at line 643 of file searchwindow.cpp.

void KMail::SearchWindow::scheduleRename

(

const QString &

s

)

[protected, slot]

Definition at line 631 of file searchwindow.cpp.

void KMail::SearchWindow::searchDone

(

)

[protected, virtual, slot]

GUI cleanup after search.

Definition at line 539 of file searchwindow.cpp.

KMMessageList KMail::SearchWindow::selectedMessages

(

)

Provides access to the list of currently selected message in the listview.

Returns:

The list of currenty selected search result messages.

Definition at line 734 of file searchwindow.cpp.

void KMail::SearchWindow::setEnabledSearchButton

(

bool

)

[protected, slot]

Definition at line 392 of file searchwindow.cpp.

void KMail::SearchWindow::setSearchPattern

(

const KMSearchPattern &

pattern

)

Definition at line 939 of file searchwindow.cpp.

void KMail::SearchWindow::slotAddMsg

(

int

idx

)

[protected, virtual, slot]

Definition at line 556 of file searchwindow.cpp.

void KMail::SearchWindow::slotClearSelection

(

)

[protected, slot]

Definition at line 846 of file searchwindow.cpp.

void KMail::SearchWindow::slotClose

(

)

[protected, virtual, slot]

Definition at line 610 of file searchwindow.cpp.

void KMail::SearchWindow::slotContextMenuRequested	(	QListViewItem *	lvi,
		const QPoint &	,
		int
	)			[protected, virtual, slot]

Definition at line 805 of file searchwindow.cpp.

void KMail::SearchWindow::slotCopyMsgs

(

)

[protected, slot]

Definition at line 926 of file searchwindow.cpp.

void KMail::SearchWindow::slotCurrentChanged

(

QListViewItem *

item

)

[protected, slot]

Definition at line 712 of file searchwindow.cpp.

void KMail::SearchWindow::slotCutMsgs

(

)

[protected, slot]

Definition at line 932 of file searchwindow.cpp.

void KMail::SearchWindow::slotFolderActivated

(

)

[protected, virtual, slot]

Definition at line 453 of file searchwindow.cpp.

void KMail::SearchWindow::slotForwardAttachedMsg

(

)

[protected, slot]

Definition at line 880 of file searchwindow.cpp.

void KMail::SearchWindow::slotForwardDigestMsg

(

)

[protected, slot]

Definition at line 887 of file searchwindow.cpp.

void KMail::SearchWindow::slotForwardInlineMsg

(

)

[protected, slot]

Definition at line 873 of file searchwindow.cpp.

void KMail::SearchWindow::slotPrintMsg

(

)

[protected, slot]

Definition at line 920 of file searchwindow.cpp.

void KMail::SearchWindow::slotRedirectMsg

(

)

[protected, slot]

Definition at line 894 of file searchwindow.cpp.

void KMail::SearchWindow::slotRemoveMsg	(	KMFolder *	,
		Q_UINT32	serNum
	)			[protected, virtual, slot]

Definition at line 585 of file searchwindow.cpp.

void KMail::SearchWindow::slotReplyAllToMsg

(

)

[protected, slot]

Definition at line 859 of file searchwindow.cpp.

void KMail::SearchWindow::slotReplyListToMsg

(

)

[protected, slot]

Definition at line 866 of file searchwindow.cpp.

void KMail::SearchWindow::slotReplyToMsg

(

)

[protected, slot]

Definition at line 852 of file searchwindow.cpp.

void KMail::SearchWindow::slotSaveAttachments

(

)

[protected, slot]

Definition at line 911 of file searchwindow.cpp.

void KMail::SearchWindow::slotSaveMsg

(

)

[protected, slot]

Definition at line 901 of file searchwindow.cpp.

void KMail::SearchWindow::slotSearch

(

)

[protected, virtual, slot]

Definition at line 466 of file searchwindow.cpp.

bool KMail::SearchWindow::slotShowMsg

(

QListViewItem *

item

)

[protected, virtual, slot]

Definition at line 683 of file searchwindow.cpp.

void KMail::SearchWindow::slotShowSelectedMsg

(

)

[protected, slot]

Definition at line 706 of file searchwindow.cpp.

void KMail::SearchWindow::slotStop

(

)

[protected, virtual, slot]

Definition at line 601 of file searchwindow.cpp.

void KMail::SearchWindow::updateContextMenuActions

(

)

[protected, virtual, slot]

Definition at line 790 of file searchwindow.cpp.

void KMail::SearchWindow::updStatus

(

void

)

[protected, virtual, slot]

Update status line widget.

Definition at line 402 of file searchwindow.cpp.

---

Member Data Documentation

QPushButton* KMail::SearchWindow::mBtnSearch [protected]

Definition at line 167 of file searchwindow.h.

QPushButton* KMail::SearchWindow::mBtnStop [protected]

Definition at line 168 of file searchwindow.h.

KMail::FolderRequester* KMail::SearchWindow::mCbxFolders [protected]

Definition at line 166 of file searchwindow.h.

QRadioButton* KMail::SearchWindow::mChkbxAllFolders [protected]

Definition at line 164 of file searchwindow.h.

QRadioButton* KMail::SearchWindow::mChkbxSpecificFolders [protected]

Definition at line 165 of file searchwindow.h.

QCheckBox* KMail::SearchWindow::mChkSubFolders [protected]

Definition at line 169 of file searchwindow.h.

KAction * KMail::SearchWindow::mClearAction [protected]

Definition at line 178 of file searchwindow.h.

bool KMail::SearchWindow::mCloseRequested [protected]

Definition at line 156 of file searchwindow.h.

KAction * KMail::SearchWindow::mCopyAction [protected]

Definition at line 178 of file searchwindow.h.

KAction * KMail::SearchWindow::mCutAction [protected]

Definition at line 178 of file searchwindow.h.

int KMail::SearchWindow::mFetchingInProgress [protected]

Definition at line 157 of file searchwindow.h.

QGuardedPtr<KMFolderSearch> KMail::SearchWindow::mFolder [protected]

Definition at line 160 of file searchwindow.h.

QValueList<QGuardedPtr<KMFolder> > KMail::SearchWindow::mFolders [protected]

Definition at line 183 of file searchwindow.h.

KActionMenu* KMail::SearchWindow::mForwardActionMenu [protected]

Definition at line 182 of file searchwindow.h.

KAction * KMail::SearchWindow::mForwardAttachedAction [protected]

Definition at line 178 of file searchwindow.h.

KAction * KMail::SearchWindow::mForwardDigestAction [protected]

Definition at line 178 of file searchwindow.h.

KAction * KMail::SearchWindow::mForwardInlineAction [protected]

Definition at line 178 of file searchwindow.h.

KMMainWidget* KMail::SearchWindow::mKMMainWidget [protected]

Definition at line 187 of file searchwindow.h.

QWidget* KMail::SearchWindow::mLastFocus [protected]

Definition at line 176 of file searchwindow.h.

KListView* KMail::SearchWindow::mLbxMatches [protected]

Definition at line 170 of file searchwindow.h.

QMap<int,KMFolder*> KMail::SearchWindow::mMenuToFolder [protected]

Definition at line 177 of file searchwindow.h.

KMSearchPatternEdit* KMail::SearchWindow::mPatternEdit [protected]

Definition at line 188 of file searchwindow.h.

KAction * KMail::SearchWindow::mPrintAction [protected]

Definition at line 178 of file searchwindow.h.

KAction * KMail::SearchWindow::mRedirectAction [protected]

Definition at line 178 of file searchwindow.h.

QTimer KMail::SearchWindow::mRenameTimer [protected]

Definition at line 184 of file searchwindow.h.

KAction* KMail::SearchWindow::mReplyAction [protected]

Definition at line 178 of file searchwindow.h.

KAction * KMail::SearchWindow::mReplyAllAction [protected]

Definition at line 178 of file searchwindow.h.

KAction * KMail::SearchWindow::mReplyListAction [protected]

Definition at line 178 of file searchwindow.h.

KAction * KMail::SearchWindow::mSaveAsAction [protected]

Definition at line 178 of file searchwindow.h.

KAction * KMail::SearchWindow::mSaveAtchAction [protected]

Definition at line 178 of file searchwindow.h.

QLineEdit* KMail::SearchWindow::mSearchFolderEdt [protected]

Definition at line 172 of file searchwindow.h.

QLabel* KMail::SearchWindow::mSearchFolderLbl [protected]

Definition at line 171 of file searchwindow.h.

QPushButton* KMail::SearchWindow::mSearchFolderOpenBtn [protected]

Definition at line 173 of file searchwindow.h.

KMSearchPattern* KMail::SearchWindow::mSearchPattern [protected]

Definition at line 189 of file searchwindow.h.

QPushButton* KMail::SearchWindow::mSearchResultOpenBtn [protected]

Definition at line 174 of file searchwindow.h.

const int KMail::SearchWindow::MSGID_COLUMN = 4 [static, protected]

Definition at line 191 of file searchwindow.h.

int KMail::SearchWindow::mSortColumn [protected]

Definition at line 158 of file searchwindow.h.

SortOrder KMail::SearchWindow::mSortOrder [protected]

Definition at line 159 of file searchwindow.h.

KStatusBar* KMail::SearchWindow::mStatusBar [protected]

Definition at line 175 of file searchwindow.h.

bool KMail::SearchWindow::mStopped [protected]

Definition at line 155 of file searchwindow.h.

QTimer* KMail::SearchWindow::mTimer [protected]

Definition at line 161 of file searchwindow.h.

---

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

• searchwindow.h
• searchwindow.cpp