KMail::FolderRequester Class Reference

#include <folderrequester.h>

Inherits TQWidget.

Signals
void	folderChanged (KMFolder *)

Public Member Functions
	FolderRequester (TQWidget *parent, KMFolderTree *tree)
KMFolder *	folder (void) const
TQString	folderId () const
TQString	text () const
void	setFolder (KMFolder *)
void	setFolder (const TQString &idString)
void	setMustBeReadWrite (bool readwrite)
void	setShowOutbox (bool show)
void	setShowImapFolders (bool show)

Protected Slots
void	slotOpenDialog ()

Protected Member Functions
virtual void	keyPressEvent (TQKeyEvent *e)

Protected Attributes
KLineEdit *	edit
KMFolder *	mFolder
KMFolderTree *	mFolderTree
TQString	mFolderId
bool	mMustBeReadWrite
bool	mShowOutbox
bool	mShowImapFolders

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

FolderRequester()

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

Constructor.

Parameters

parent	the parent widget
tree	the KMFolderTree to get the folders

Definition at line 44 of file folderrequester.cpp.

Member Function Documentation

folder()

KMFolder * KMail::FolderRequester::folder

(

void

)

const

Returns selected folder.

Definition at line 81 of file folderrequester.cpp.

folderChanged

void KMail::FolderRequester::folderChanged ( KMFolder *  )

signal

Emitted when the folder changed.

folderId()

TQString KMail::FolderRequester::folderId ( ) const

inline

Returns the folder id.

Definition at line 64 of file folderrequester.h.

keyPressEvent()

void KMail::FolderRequester::keyPressEvent ( TQKeyEvent *  e )

protectedvirtual

Capture space key to open the dialog.

Definition at line 117 of file folderrequester.cpp.

setFolder()

void KMail::FolderRequester::setFolder

(

KMFolder *

folder

)

Preset the folder.

Definition at line 87 of file folderrequester.cpp.

setMustBeReadWrite()

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 78 of file folderrequester.h.

setShowImapFolders()

void KMail::FolderRequester::setShowImapFolders ( bool  show )

inline

Set if the imap folders should be shown.

Definition at line 86 of file folderrequester.h.

setShowOutbox()

void KMail::FolderRequester::setShowOutbox ( bool  show )

inline

Set if the outbox should be shown.

Definition at line 82 of file folderrequester.h.

slotOpenDialog

void KMail::FolderRequester::slotOpenDialog ( )

protectedslot

Open the folder dialog.

Definition at line 64 of file folderrequester.cpp.

text()

TQString KMail::FolderRequester::text ( ) const

inline

Returns current text.

Definition at line 67 of file folderrequester.h.

---

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

• folderrequester.h
• folderrequester.cpp