Akonadi::ControlGui
#include <controlgui.h>
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 | |
Properties inherited from QObject | |
objectName | |
Public Attributes inherited from QObject | |
typedef | QObjectList |
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:
- See also
- Akonadi::ServerManager
Definition at line 53 of file controlgui.h.
Constructor & Destructor Documentation
◆ ~ControlGui()
|
overridedefault |
Destroys the ControlGui object.
◆ ControlGui()
|
protected |
Creates the ControlGui object.
Definition at line 161 of file controlgui.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 211 of file controlgui.cpp.
◆ restart() [2/2]
|
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]
|
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]
|
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]
|
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]
|
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()
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:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:13:38 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.