Akonadi::Control Class Reference

Provides methods to control the Akonadi server process. More...

#include <control.h>

Inherits QObject.

Inherited by StaticControl.

List of all members.

Public Member Functions
	~Control ()
Static Public Member Functions
static bool	restart (QWidget *parent)
static bool	restart ()
static bool	start (QWidget *parent)
static bool	start ()
static bool	stop (QWidget *parent)
static bool	stop ()
static void	widgetNeedsAkonadi (QWidget *widget)
Protected Member Functions
	Control ()

---

Detailed Description

Provides methods to control the Akonadi server process.

This class provides high-level methods to control the Akonadi server. These methods are synchronously (ie. use a sub-eventloop) and can show dialogs. For more low-level methods see Akonadi::ServerManager.

While the Akonadi server normally is started by the KDE session manager, it is not guaranteed that your application is running inside a KDE session. Therefore it is recommended to execute Akonadi::Control::start() during startup to ensure the Akonadi server is running.

Example:

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

Author:

Volker Krause <vkrause@kde.org>

See also:

Akonadi::ServerManager

Definition at line 60 of file control.h.

---

Constructor & Destructor Documentation

Control::~Control

(

)

Destroys the control object.

Definition at line 192 of file control.cpp.

Control::Control

(

)

[protected]

Creates the control object.

Definition at line 181 of file control.cpp.

---

Member Function Documentation

bool Control::restart

(

QWidget *

parent

)

[static]

Same as restart(), but with GUI feedback.

Parameters:

parent

The parent widget.

Since:

4.2

Definition at line 242 of file control.cpp.

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

bool Control::start

(

QWidget *

parent

)

[static]

Same as start(), but with GUI feedback.

Parameters:

parent

The parent widget.

Since:

4.2

Definition at line 230 of file control.cpp.

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

bool Control::stop

(

QWidget *

parent

)

[static]

Same as stop(), but with GUI feedback.

Parameters:

parent

The parent widget.

Since:

4.2

Definition at line 236 of file control.cpp.

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

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

Parameters:

widget

The widget depending on Akonadi being operational.

Since:

4.2

Definition at line 251 of file control.cpp.

---

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

• control.h
• control.cpp