Akonadi::ControlGui Class Reference

#include <controlgui.h>

Inheritance diagram for Akonadi::ControlGui:

Public Member Functions
	~ControlGui () override
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () 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 () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, 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
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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
T	qobject_cast (const QObject *object)
T	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	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const 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
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)

Protected Member Functions
	ControlGui ()
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
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName

Detailed Description

Provides methods to ControlGui the Akonadi server process.

This class provides synchronous methods (ie. use a sub-eventloop) to ControlGui 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::ControlGui::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 53 of file controlgui.h.

Constructor & Destructor Documentation

~ControlGui()

Akonadi::ControlGui::~ControlGui ( )

overridedefault

Destroys the ControlGui object.

ControlGui()

Akonadi::ControlGui::ControlGui ( )

protected

Creates the ControlGui object.

Definition at line 161 of file controlgui.cpp.

Member Function Documentation

restart() [1/2]

bool Akonadi::ControlGui::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 211 of file controlgui.cpp.

restart() [2/2]

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

static

Same as restart(), but with GUI feedback.

Parameters

parent

The parent widget.

Since

4.2

Definition at line 233 of file controlgui.cpp.

start() [1/2]

bool Akonadi::ControlGui::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 178 of file controlgui.cpp.

start() [2/2]

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

static

Same as start(), but with GUI feedback.

Parameters

parent

The parent widget.

Since

4.2

Definition at line 221 of file controlgui.cpp.

stop() [1/2]

bool Akonadi::ControlGui::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 196 of file controlgui.cpp.

stop() [2/2]

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

static

Same as stop(), but with GUI feedback.

Parameters

parent

The parent widget.

Since

4.2

Definition at line 227 of file controlgui.cpp.

widgetNeedsAkonadi()

void Akonadi::ControlGui::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 243 of file controlgui.cpp.

---

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

• controlgui.h
• controlgui.cpp