MailCommon::Kernel

Search for usage in LXR

#include <mailkernel.h>

Inheritance diagram for MailCommon::Kernel:

Signals

void requestConfigSync ()
 
void requestSystemTrayUpdate ()
 

Public Member Functions

Akonadi::Collection collectionFromId (Akonadi::Collection::Id id) const
 
Akonadi::Collection draftsCollectionFolder ()
 
void emergencyExit (const QString &reason)
 
IFilterfilterIf () 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::ImapResourceCapabilitiesManagerimapResourceManager () const
 
Akonadi::Collection inboxCollectionFolder ()
 
void initFolders ()
 
bool isMainFolderCollection (const Akonadi::Collection &col)
 
bool isSystemFolderCollection (const Akonadi::Collection &col)
 
IKernelkernelIf () const
 
bool kernelIsRegistered () const
 
Akonadi::Collection outboxCollectionFolder ()
 
void registerFilterIf (IFilter *filterIf)
 
void registerKernelIf (IKernel *kernelIf)
 
void registerSettingsIf (ISettings *settingsIf)
 
Akonadi::Collection sentCollectionFolder ()
 
ISettingssettingsIf () const
 
Akonadi::Collection templatesCollectionFolder ()
 
Akonadi::Collection trashCollectionFolder ()
 
Akonadi::Collection trashCollectionFromResource (const Akonadi::Collection &col)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static bool folderIsInbox (const Akonadi::Collection &)
 
static QMap< QString, Akonadi::Collection::Idpop3ResourceTargetCollection ()
 
static Kernelself ()
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
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)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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 32 of file mailkernel.h.

Member Function Documentation

◆ collectionFromId()

Akonadi::Collection MailCommon::Kernel::collectionFromId ( 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 111 of file mailkernel.cpp.

◆ folderIsDraftOrOutbox()

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 251 of file mailkernel.cpp.

◆ folderIsSentMailFolder()

bool MailCommon::Kernel::folderIsSentMailFolder ( const Akonadi::Collection col)

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

Definition at line 329 of file mailkernel.cpp.

◆ folderIsTrash()

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 313 of file mailkernel.cpp.

◆ isMainFolderCollection()

bool MailCommon::Kernel::isMainFolderCollection ( const Akonadi::Collection col)

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

Definition at line 152 of file mailkernel.cpp.

◆ registerFilterIf()

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

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.cpp.

◆ registerKernelIf()

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

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 68 of file mailkernel.cpp.

◆ registerSettingsIf()

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

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 84 of file mailkernel.cpp.

◆ trashCollectionFromResource()

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 303 of file mailkernel.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Wed Sep 28 2022 03:59:03 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.