File indexing completed on 2025-01-05 04:47:08

 /*
     SPDX-FileCopyrightText: 2007 Volker Krause <vkrause@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #pragma once
 
 #include "akonadiwidgets_export.h"
 
 #include <QObject>
 
 #include <memory>
 
 namespace Akonadi
 {
 class ControlGuiPrivate;
 
 /**
  * @short 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:
  *
  * @code
  *
  * if ( !Akonadi::ControlGui::start() ) {
  *   qDebug() << "Unable to start Akonadi server, exit application";
  *   return 1;
  * } else {
  *   ...
  * }
  *
  * @endcode
  *
  * @author Volker Krause <vkrause@kde.org>
  *
  * @see Akonadi::ServerManager
  */
 class AKONADIWIDGETS_EXPORT ControlGui : public QObject
 {
     Q_OBJECT
 
 public:
     /**
      * Destroys the ControlGui object.
      */
     ~ControlGui() override;
 
     /**
      * 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 ControlGui object.
      */
     ControlGui();
 
 private:
     /// @cond PRIVATE
     std::unique_ptr<ControlGuiPrivate> const d;
     /// @endcond
 };
 
 }