/usr/include/akonadi/control.h is in kdepimlibs5-dev 4:4.14.10-1ubuntu7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | /*
Copyright (c) 2007 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_CONTROL_H
#define AKONADI_CONTROL_H
#include "akonadi_export.h"
#include <QtCore/QObject>
namespace Akonadi {
/**
* @short 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:
*
* @code
*
* if ( !Akonadi::Control::start() ) {
* qDebug() << "Unable to start Akonadi server, exit application";
* return 1;
* } else {
* ...
* }
*
* @endcode
*
* @author Volker Krause <vkrause@kde.org>
*
* @see Akonadi::ServerManager
*/
class AKONADI_EXPORT Control : public QObject
{
Q_OBJECT
public:
/**
* Destroys the control object.
*/
~Control();
/**
* Starts the Akonadi server synchronously if it is not already running.
* @return @c true if the server was started successfully or was already
* running, @c false otherwise
*/
static bool start();
/**
* Same as start(), but with GUI feedback.
* @param parent The parent widget.
* @since 4.2
*/
static bool start(QWidget *parent);
/**
* Stops the Akonadi server synchronously if it is currently running.
* @return @c true if the server was shutdown successfully or was
* not running at all, @c false otherwise.
* @since 4.2
*/
static bool stop();
/**
* Same as stop(), but with GUI feedback.
* @param parent The parent widget.
* @since 4.2
*/
static bool stop(QWidget *parent);
/**
* Restarts the Akonadi server synchronously.
* @return @c true if the restart was successful, @c false otherwise,
* the server state is undefined in this case.
* @since 4.2
*/
static bool restart();
/**
* Same as restart(), but with GUI feedback.
* @param parent The parent widget.
* @since 4.2
*/
static bool restart(QWidget *parent);
/**
* Disable the given widget when Akonadi is not operational and show
* an error overlay (given enough space). Cascading use is automatically
* detected and resolved.
* @param widget The widget depending on Akonadi being operational.
* @since 4.2
*/
static void widgetNeedsAkonadi(QWidget *widget);
protected:
/**
* Creates the control object.
*/
Control();
private:
//@cond PRIVATE
class Private;
Private *const d;
Q_PRIVATE_SLOT(d, void serverStateChanged(Akonadi::ServerManager::State))
Q_PRIVATE_SLOT(d, void createErrorOverlays())
Q_PRIVATE_SLOT(d, void cleanup())
//@endcond
};
}
#endif
|