• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

Akonadi::Control

Akonadi::Control Class Reference

#include <control.h>

Inherits QObject.

Inherited by StaticControl.

List of all members.


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.


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 ()

Constructor & Destructor Documentation

Control::~Control (  ) 

Destroys the control object.

Definition at line 167 of file control.cpp.

Control::Control (  )  [protected]

Creates the control object.

Definition at line 160 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 217 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 196 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 205 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 172 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 211 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 184 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 226 of file control.cpp.


The documentation for this class was generated from the following files:
  • control.h
  • control.cpp

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.6
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal