Akonadi::Control Class Reference

#include <control.h>

Inheritance diagram for Akonadi::Control:

Public Member Functions
	~Control ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
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	restart ()
static bool	restart (QWidget *parent)
static bool	start ()
static bool	start (QWidget *parent)
static bool	stop ()
static bool	stop (QWidget *parent)
static void	widgetNeedsAkonadi (QWidget *widget)
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)

Protected Member Functions
	Control ()
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)

Additional Inherited Members
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Provides methods to control the Akonadi server process.

This class provides synchronous methods (ie. use a sub-eventloop) to control the Akonadi service. For asynchronous methods see Akonadi::ServerManager.

The most important method in here is widgetNeedsAkonadi(). It is recommended to call it with every top-level widget of your application as argument, assuming your application relies on Akonadi being operational of course.

While the Akonadi server automatically started by Akonadi::Session on first use, it might be necessary for some use-cases to guarantee a running Akonadi service at some point. This can be done using start().

Example:

if ( !Akonadi::Control::start() ) {
  qDebug() << "Unable to start Akonadi server, exit application";
  return 1;
} else {
  ...
}

Author

Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

See also

Akonadi::ServerManager

Definition at line 62 of file control.h.

Constructor & Destructor Documentation

Akonadi::Control::~Control

(

)

Destroys the control object.

Definition at line 194 of file control.cpp.

Akonadi::Control::Control ( )

protected

Creates the control object.

Definition at line 182 of file control.cpp.

Member Function Documentation

bool Akonadi::Control::restart ( )

static

Restarts the Akonadi server synchronously.

Returns

true if the restart was successful, false otherwise, the server state is undefined in this case.

Since

4.2

Definition at line 232 of file control.cpp.

bool Akonadi::Control::restart ( QWidget *  parent )

static

Same as restart(), but with GUI feedback.

Parameters

parent

The parent widget.

Since

4.2

Definition at line 254 of file control.cpp.

bool Akonadi::Control::start ( )

static

Starts the Akonadi server synchronously if it is not already running.

Returns

true if the server was started successfully or was already running, false otherwise

Definition at line 199 of file control.cpp.

bool Akonadi::Control::start ( QWidget *  parent )

static

Same as start(), but with GUI feedback.

Parameters

parent

The parent widget.

Since

4.2

Definition at line 242 of file control.cpp.

bool Akonadi::Control::stop ( )

static

Stops the Akonadi server synchronously if it is currently running.

Returns

true if the server was shutdown successfully or was not running at all, false otherwise.

Since

4.2

Definition at line 217 of file control.cpp.

bool Akonadi::Control::stop ( QWidget *  parent )

static

Same as stop(), but with GUI feedback.

Parameters

parent

The parent widget.

Since

4.2

Definition at line 248 of file control.cpp.

void Akonadi::Control::widgetNeedsAkonadi ( QWidget *  widget )

static

Disable the given widget when Akonadi is not operational and show an error overlay (given enough space).

Cascading use is automatically detected and resolved.

Parameters

widget

The widget depending on Akonadi being operational.

Since

4.2

Definition at line 264 of file control.cpp.

---

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

• control.h
• control.cpp