MailCommon::FolderRequester Class Reference

#include <folderrequester.h>

Inheritance diagram for MailCommon::FolderRequester:

Signals
void	folderChanged (const Akonadi::Collection &)

Public Member Functions
	FolderRequester (QWidget *parent=0)
virtual	~FolderRequester ()
Akonadi::Collection	collection () const
bool	hasCollection () const
void	setCollection (const Akonadi::Collection &collection, bool fetchCollection=true)
void	setMustBeReadWrite (bool readwrite)
void	setNotAllowToCreateNewFolder (bool notCreateNewFolder)
void	setShowOutbox (bool show)

Protected Slots
void	slotCollectionsReceived (KJob *)
void	slotOpenDialog ()

Protected Member Functions
void	keyPressEvent (QKeyEvent *e)
void	setCollectionFullPath (const Akonadi::Collection &col)

Protected Attributes
Akonadi::Collection	mCollection
KLineEdit *	mEdit
bool	mMustBeReadWrite
bool	mNotCreateNewFolder
bool	mShowOutbox

Detailed Description

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

Todo:

This should be cleaned up and go into libakonadi. This includes:

• s/Folder/Collection/g
• Use Akonadi::CollectionDialog instead of MailCommon::FolderSelectionDialog
  • merge that into CollectionDialog
  • or allow to replace the built-in dialog by your own
• Allow to pass in an existing ETM, to remove the Kernel dependency

Definition at line 59 of file folderrequester.h.

Constructor & Destructor Documentation

MailCommon::FolderRequester::FolderRequester ( QWidget *  parent = 0 )

explicit

Constructor.

Parameters

parent

the parent widget

Definition at line 50 of file folderrequester.cpp.

MailCommon::FolderRequester::~FolderRequester ( )

virtual

Definition at line 101 of file folderrequester.cpp.

Member Function Documentation

Akonadi::Collection MailCommon::FolderRequester::collection

(

)

const

Returns the selected collection.

Definition at line 105 of file folderrequester.cpp.

void MailCommon::FolderRequester::folderChanged ( const Akonadi::Collection &  )

signal

Emitted when the folder changed.

bool MailCommon::FolderRequester::hasCollection

(

)

const

Returns true if there's a valid collection set on this widget.

Definition at line 165 of file folderrequester.cpp.

void MailCommon::FolderRequester::keyPressEvent ( QKeyEvent *  e )

protected

Capture space key to open the dialog.

Definition at line 171 of file folderrequester.cpp.

void MailCommon::FolderRequester::setCollection	(	const Akonadi::Collection &	collection,
		bool	fetchCollection = true
	)

Presets the folder to the collection collection.

Disable fetchcollection when not necessary fetchCollection

Definition at line 120 of file folderrequester.cpp.

void MailCommon::FolderRequester::setCollectionFullPath ( const Akonadi::Collection &  col )

protected

Definition at line 110 of file folderrequester.cpp.

void MailCommon::FolderRequester::setMustBeReadWrite

(

bool

readwrite

)

Sets 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 180 of file folderrequester.cpp.

void MailCommon::FolderRequester::setNotAllowToCreateNewFolder

(

bool

notCreateNewFolder

)

Definition at line 190 of file folderrequester.cpp.

void MailCommon::FolderRequester::setShowOutbox

(

bool

show

)

Definition at line 185 of file folderrequester.cpp.

void MailCommon::FolderRequester::slotCollectionsReceived ( KJob *  job )

protectedslot

Updates the information we have about the current folder.

Definition at line 140 of file folderrequester.cpp.

void MailCommon::FolderRequester::slotOpenDialog ( )

protectedslot

Opens the folder dialog.

Definition at line 76 of file folderrequester.cpp.

Member Data Documentation

Akonadi::Collection MailCommon::FolderRequester::mCollection

protected

Definition at line 121 of file folderrequester.h.

KLineEdit* MailCommon::FolderRequester::mEdit

protected

Definition at line 122 of file folderrequester.h.

bool MailCommon::FolderRequester::mMustBeReadWrite

protected

Definition at line 123 of file folderrequester.h.

bool MailCommon::FolderRequester::mNotCreateNewFolder

protected

Definition at line 125 of file folderrequester.h.

bool MailCommon::FolderRequester::mShowOutbox

protected

Definition at line 124 of file folderrequester.h.

---

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

• folderrequester.h
• folderrequester.cpp