akonadi
#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:
- See also
- Akonadi::ServerManager
Constructor & Destructor Documentation
◆ ~Control()
Akonadi::Control::~Control | ( | ) |
Destroys the control object.
Definition at line 194 of file control.cpp.
◆ Control()
|
protected |
Creates the control object.
Definition at line 182 of file control.cpp.
Member Function Documentation
◆ restart() [1/2]
|
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.
◆ restart() [2/2]
|
static |
Same as restart(), but with GUI feedback.
- Parameters
-
parent The parent widget.
- Since
- 4.2
Definition at line 254 of file control.cpp.
◆ start() [1/2]
|
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.
◆ start() [2/2]
|
static |
Same as start(), but with GUI feedback.
- Parameters
-
parent The parent widget.
- Since
- 4.2
Definition at line 242 of file control.cpp.
◆ stop() [1/2]
|
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.
◆ stop() [2/2]
|
static |
Same as stop(), but with GUI feedback.
- Parameters
-
parent The parent widget.
- Since
- 4.2
Definition at line 248 of file control.cpp.
◆ widgetNeedsAkonadi()
|
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:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.