Akonadi::Control Class Reference

#include <control.h>

Inherits QObject.

Inherited by Akonadi::Internal::StaticControl.

Public Member Functions
	~Control ()

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)

Protected Member Functions
	Control ()

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 195 of file control.cpp.

Akonadi::Control::Control ( )

protected

Creates the control object.

Definition at line 183 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 233 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 255 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 200 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 243 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 218 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 249 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 265 of file control.cpp.

---

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

• control.h
• control.cpp