KMail::FolderRequester Class Reference

A widget that contains a KLineEdit which shows the current folder and a button that fires a KMFolderSelDlg The dialog is set to disable readonly folders by default Search folders are excluded. More...

#include <folderrequester.h>

Inheritance diagram for KMail::FolderRequester:

[legend]

List of all members.


Signals
void	folderChanged (KMFolder *)
Public Member Functions
KMFolder *	folder (void) const
QString	folderId () const
	FolderRequester (QWidget parent, KMFolderTree tree)
void	setFolder (const QString &idString)
void	setFolder (KMFolder *)
void	setMustBeReadWrite (bool readwrite)
void	setShowImapFolders (bool show)
void	setShowOutbox (bool show)
QString	text () const
virtual	~FolderRequester ()
Protected Slots
void	slotOpenDialog ()
Protected Member Functions
virtual void	keyPressEvent (QKeyEvent *e)
Protected Attributes
KLineEdit *	edit
KMFolder *	mFolder
QString	mFolderId
KMFolderTree *	mFolderTree
bool	mMustBeReadWrite
bool	mShowImapFolders
bool	mShowOutbox

Detailed Description

A widget that contains a KLineEdit which shows the current folder and a button that fires a KMFolderSelDlg The dialog is set to disable readonly folders by default Search folders are excluded.

Definition at line 46 of file folderrequester.h.

Constructor & Destructor Documentation

KMail::FolderRequester::FolderRequester	(	QWidget *	parent,
		KMFolderTree *	tree
	)

Constructor.

Parameters:

	parent	the parent widget
	tree	the KMFolderTree to get the folders

Definition at line 44 of file folderrequester.cpp.

KMail::FolderRequester::~FolderRequester ( ) [virtual]

Definition at line 76 of file folderrequester.cpp.

Member Function Documentation

KMFolder * KMail::FolderRequester::folder ( void ) const

Returns selected folder.

Definition at line 81 of file folderrequester.cpp.

void KMail::FolderRequester::folderChanged ( KMFolder * ) [signal]

Emitted when the folder changed.

QString KMail::FolderRequester::folderId ( ) const [inline]

Returns the folder id.

Definition at line 63 of file folderrequester.h.

void KMail::FolderRequester::keyPressEvent ( QKeyEvent * e ) [protected, virtual]

Capture space key to open the dialog.

Reimplemented from QWidget.

Definition at line 117 of file folderrequester.cpp.

void KMail::FolderRequester::setFolder ( const QString & idString )

Definition at line 100 of file folderrequester.cpp.

void KMail::FolderRequester::setFolder ( KMFolder * folder )

Preset the folder.

Definition at line 87 of file folderrequester.cpp.

void KMail::FolderRequester::setMustBeReadWrite ( bool readwrite ) [inline]

Set if readonly folders should be disabled Be aware that if you disable this the user can also select the 'Local Folders' folder which has no valid folder associated.

Definition at line 77 of file folderrequester.h.

void KMail::FolderRequester::setShowImapFolders ( bool show ) [inline]

Set if the imap folders should be shown.

Definition at line 85 of file folderrequester.h.

void KMail::FolderRequester::setShowOutbox ( bool show ) [inline]

Set if the outbox should be shown.

Definition at line 81 of file folderrequester.h.

void KMail::FolderRequester::slotOpenDialog ( ) [protected, slot]

Open the folder dialog.

Definition at line 64 of file folderrequester.cpp.

QString KMail::FolderRequester::text ( ) const [inline]

Returns current text.