MailCommon::Kernel Class Reference

#include <mailkernel.h>

Inheritance diagram for MailCommon::Kernel:

Signals
void	requestConfigSync ()
void	requestSystemTrayUpdate ()

Public Member Functions
virtual	~Kernel ()
Akonadi::Collection	collectionFromId (const Akonadi::Collection::Id &id) const
Akonadi::Collection	draftsCollectionFolder ()
void	emergencyExit (const QString &reason)
IFilter *	filterIf () const
bool	folderIsDraftOrOutbox (const Akonadi::Collection &collection)
bool	folderIsDrafts (const Akonadi::Collection &)
bool	folderIsSentMailFolder (const Akonadi::Collection &)
bool	folderIsTemplates (const Akonadi::Collection &collection)
bool	folderIsTrash (const Akonadi::Collection &collection)
PimCommon::ImapResourceCapabilitiesManager *	imapResourceManager () const
Akonadi::Collection	inboxCollectionFolder ()
void	initFolders ()
bool	isMainFolderCollection (const Akonadi::Collection &col)
bool	isSystemFolderCollection (const Akonadi::Collection &col)
IKernel *	kernelIf () const
bool	kernelIsRegistered () const
Akonadi::Collection	outboxCollectionFolder ()
void	registerFilterIf (IFilter *filterIf)
void	registerKernelIf (IKernel *kernelIf)
void	registerSettingsIf (ISettings *settingsIf)
Akonadi::Collection	sentCollectionFolder ()
ISettings *	settingsIf () const
Akonadi::Collection	templatesCollectionFolder ()
Akonadi::Collection	trashCollectionFolder ()
Akonadi::Collection	trashCollectionFromResource (const Akonadi::Collection &col)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Static Public Member Functions
static bool	folderIsInbox (const Akonadi::Collection &, bool withoutPop3InboxSetting=false)
static Kernel *	self ()
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Deals with common mail application related operations.

The required interfaces MUST be registered before using it! Be careful when using in multi-threaded applications, as Kernel is a QObject singleton, created in the main thread, thus event handling for Kernel::self() will happen in the main thread.

Definition at line 44 of file mailkernel.h.

Constructor & Destructor Documentation

MailCommon::Kernel::~Kernel ( )

virtual

Definition at line 68 of file mailkernel.cpp.

Member Function Documentation

Akonadi::Collection MailCommon::Kernel::collectionFromId

(

const Akonadi::Collection::Id &

id

)

const

Returns the collection associated with the given id, or an invalid collection if not found.

The EntityTreeModel of the kernel is searched for the collection. Since the ETM is loaded async, this method will not find the collection right after startup, when the ETM is not yet fully loaded.

Definition at line 83 of file mailkernel.cpp.

Akonadi::Collection MailCommon::Kernel::draftsCollectionFolder

(

)

Definition at line 120 of file mailkernel.cpp.

void MailCommon::Kernel::emergencyExit

(

const QString &

reason

)

Definition at line 218 of file mailkernel.cpp.

IFilter* MailCommon::Kernel::filterIf ( ) const

inline

Definition at line 100 of file mailkernel.h.

bool MailCommon::Kernel::folderIsDraftOrOutbox

(

const Akonadi::Collection &

collection

)

Returns true if the folder is either the outbox or one of the drafts-folders.

Definition at line 241 of file mailkernel.cpp.

bool MailCommon::Kernel::folderIsDrafts

(

const Akonadi::Collection &

col

)

Definition at line 250 of file mailkernel.cpp.

bool MailCommon::Kernel::folderIsInbox ( const Akonadi::Collection &  collection, bool  withoutPop3InboxSetting = false  )

static

Definition at line 342 of file mailkernel.cpp.

bool MailCommon::Kernel::folderIsSentMailFolder

(

const Akonadi::Collection &

col

)

Returns true if the folder is one of the sent-mail folders.

Definition at line 320 of file mailkernel.cpp.

bool MailCommon::Kernel::folderIsTemplates

(

const Akonadi::Collection &

collection

)

Definition at line 272 of file mailkernel.cpp.

bool MailCommon::Kernel::folderIsTrash

(

const Akonadi::Collection &

collection

)

Returns true if the folder is a trash folder.

When calling this too early (before the SpecialMailCollectionsDiscoveryJob from initFolders finishes), it will say false erroneously. However you can connect to SpecialMailCollections::collectionsChanged to react on dynamic changes and call this again.

Definition at line 304 of file mailkernel.cpp.

PimCommon::ImapResourceCapabilitiesManager * MailCommon::Kernel::imapResourceManager

(

)

const

Definition at line 78 of file mailkernel.cpp.

Akonadi::Collection MailCommon::Kernel::inboxCollectionFolder

(

)

Definition at line 99 of file mailkernel.cpp.

void MailCommon::Kernel::initFolders

(

)

Definition at line 150 of file mailkernel.cpp.

bool MailCommon::Kernel::isMainFolderCollection

(

const Akonadi::Collection &

col

)

Returns true if this folder is the inbox on the local disk.

Definition at line 144 of file mailkernel.cpp.

bool MailCommon::Kernel::isSystemFolderCollection

(

const Akonadi::Collection &

col

)

Definition at line 134 of file mailkernel.cpp.

IKernel* MailCommon::Kernel::kernelIf ( ) const

inline

Definition at line 68 of file mailkernel.h.

bool MailCommon::Kernel::kernelIsRegistered ( ) const

inline

Definition at line 63 of file mailkernel.h.

Akonadi::Collection MailCommon::Kernel::outboxCollectionFolder

(

)

Definition at line 106 of file mailkernel.cpp.

void MailCommon::Kernel::registerFilterIf ( IFilter *  filterIf )

inline

Registers the interface dealing with mail settings.

This function MUST be called with a valid interface pointer, before any Kernel::self() method is used. The pointer ownership will not be transferred to Kernel.

Definition at line 95 of file mailkernel.h.

void MailCommon::Kernel::registerKernelIf ( IKernel *  kernelIf )

inline

Registers the interface dealing with main mail functionality.

This function MUST be called with a valid interface pointer, before any Kernel::self() method is used. The pointer ownership will not be transferred to Kernel.

Definition at line 58 of file mailkernel.h.

void MailCommon::Kernel::registerSettingsIf ( ISettings *  settingsIf )

inline

Registers the interface dealing with mail settings.

This function MUST be called with a valid interface pointer, before any Kernel::self() method is used. The pointer ownership will not be transferred to Kernel.

Definition at line 79 of file mailkernel.h.

void MailCommon::Kernel::requestConfigSync ( )

signal

void MailCommon::Kernel::requestSystemTrayUpdate ( )

signal

Kernel * MailCommon::Kernel::self ( )

static

Definition at line 73 of file mailkernel.cpp.

Akonadi::Collection MailCommon::Kernel::sentCollectionFolder

(

)

Definition at line 113 of file mailkernel.cpp.

ISettings* MailCommon::Kernel::settingsIf ( ) const

inline

Definition at line 84 of file mailkernel.h.

Akonadi::Collection MailCommon::Kernel::templatesCollectionFolder

(

)

Definition at line 127 of file mailkernel.cpp.

Akonadi::Collection MailCommon::Kernel::trashCollectionFolder

(

)

Definition at line 92 of file mailkernel.cpp.

Akonadi::Collection MailCommon::Kernel::trashCollectionFromResource

(

const Akonadi::Collection &

col

)

Returns the trash folder for the resource which col belongs to.

When calling this too early (before the SpecialMailCollectionsDiscoveryJob from initFolders finishes), it will return an invalid collection erroneously. However you can connect to SpecialMailCollections::collectionsChanged to react on dynamic changes and call this again.

Definition at line 294 of file mailkernel.cpp.

---

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

• mailkernel.h
• mailkernel.cpp