File indexing completed on 2024-05-19 16:31:23

 /*
  *   SPDX-FileCopyrightText: 2010-2016 Ivan Cukic <ivan.cukic@kde.org>
  *
  *   SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
  */
 
 #ifndef ACTIVITIES_H
 #define ACTIVITIES_H
 
 // Qt
 #include <QString>
 #include <QStringList>
 
 // Utils
 #include <utils/d_ptr.h>
 
 // Local
 #include "Module.h"
 #include <common/dbus/org.kde.ActivityManager.Activities.h>
 
 /**
  * Service for tracking the user actions and managing the
  * activities
  */
 class Activities : public Module
 {
     Q_OBJECT
     Q_CLASSINFO("D-Bus Interface", "org.kde.ActivityManager.Activities")
     Q_PROPERTY(QString CurrentActivity READ CurrentActivity WRITE SetCurrentActivity NOTIFY CurrentActivityChanged)
 
 public:
     /**
      * Activity state
      * @note: Do not change the values, needed for bit-operations
      */
     enum State {
         Invalid = 0,
         Running = 2,
         Starting = 3,
         Stopped = 4,
         Stopping = 5,
     };
 
     /**
      * Creates new Activities object
      */
     explicit Activities(QObject *parent = nullptr);
 
     /**
      * Destroys this interface
      */
     ~Activities() override;
 
     // workspace activities control
 public Q_SLOTS:
     /**
      * @returns the id of the current activity, empty string if none
      */
     QString CurrentActivity() const;
 
     /**
      * Sets the current activity
      * @param activity id of the activity to make current
      */
     bool SetCurrentActivity(const QString &activity);
 
     /**
      * Switches to the previous activity
      */
     bool PreviousActivity();
 
     /**
      * Switches to the next activity
      */
     bool NextActivity();
 
     /**
      * Adds a new activity
      * @param name name of the activity
      * @returns id of the newly created activity
      */
     QString AddActivity(const QString &name);
 
     /**
      * Starts the specified activity
      * @param activity id of the activity to stash
      */
     void StartActivity(const QString &activity);
 
     /**
      * Stops the specified activity
      * @param activity id of the activity to stash
      */
     void StopActivity(const QString &activity);
 
     /**
      * @returns the state of the activity
      * @param activity id of the activity
      */
     int ActivityState(const QString &activity) const;
 
     /**
      * Removes the specified activity
      * @param activity id of the activity to delete
      */
     void RemoveActivity(const QString &activity);
 
     /**
      * @returns the list of all existing activities
      */
     QStringList ListActivities() const;
 
     /**
      * @returns the list of activities with the specified state
      * @param state state
      */
     QStringList ListActivities(int state) const;
 
     /**
      * @returns the name of the specified activity
      * @param activity id of the activity
      */
     QString ActivityName(const QString &activity) const;
 
     /**
      * Sets the name of the specified activity
      * @param activity id of the activity
      * @param name name to be set
      */
     void SetActivityName(const QString &activity, const QString &name);
 
     /**
      * @returns the description of the specified activity
      * @param activity id of the activity
      */
     QString ActivityDescription(const QString &activity) const;
 
     /**
      * Sets the description of the specified activity
      * @param activity id of the activity
      * @param description description to be set
      */
     void SetActivityDescription(const QString &activity, const QString &description);
 
     /**
      * @returns the icon of the specified activity
      * @param activity id of the activity
      */
     QString ActivityIcon(const QString &activity) const;
 
     /**
      * Sets the icon of the specified activity
      * @param activity id of the activity
      * @param icon icon to be set
      */
     void SetActivityIcon(const QString &activity, const QString &icon);
 
 public Q_SLOTS:
     /**
      * @returns a list of activities with basic info about them
      */
     ActivityInfoList ListActivitiesWithInformation() const;
 
     /**
      * @returns the info about an activity
      */
     ActivityInfo ActivityInformation(const QString &activity) const;
 
 Q_SIGNALS:
     /**
      * This signal is emitted when the global
      * activity is changed
      * @param activity id of the new current activity
      */
     void CurrentActivityChanged(const QString &activity);
 
     /**
      * This signal is emitted when a new activity is created
      * @param activity id of the activity
      */
     void ActivityAdded(const QString &activity);
 
     /**
      * This signal is emitted when an activity is started
      * @param activity id of the activity
      */
     void ActivityStarted(const QString &activity);
 
     /**
      * This signal is emitted when an activity is stashed
      * @param activity id of the activity
      */
     void ActivityStopped(const QString &activity);
 
     /**
      * This signal is emitted when an activity is deleted
      * @param activity id of the activity
      */
     void ActivityRemoved(const QString &activity);
 
     /**
      * Emitted when an activity name is changed
      * @param activity id of the changed activity
      * @param name name of the changed activity
      */
     void ActivityNameChanged(const QString &activity, const QString &name);
 
     /**
      * Emitted when an activity description is changed
      * @param activity id of the changed activity
      * @param description description of the changed activity
      */
     void ActivityDescriptionChanged(const QString &activity, const QString &description);
 
     /**
      * Emitted when an activity icon is changed
      * @param activity id of the changed activity
      * @param icon name of the changed activity
      */
     void ActivityIconChanged(const QString &activity, const QString &icon);
 
     /**
      * Emitted when an activity is changed (name, icon, or some other property)
      * @param activity id of the changed activity
      */
     void ActivityChanged(const QString &activity);
 
     /**
      * Emitted when the state of activity is changed
      */
     void ActivityStateChanged(const QString &activity, int state);
 
 private:
     D_PTR;
 };
 
 #endif // ACTIVITIES_H