workspace/libs/taskmanager/taskmanager.h

   1 /*****************************************************************
   2
   3 Copyright (c) 2000-2001 Matthias Elter <elter@kde.org>
   4 Copyright (c) 2001 Richard Moore <rich@kde.org>
   5
   6 Permission is hereby granted, free of charge, to any person obtaining a copy
   7 of this software and associated documentation files (the "Software"), to deal
   8 in the Software without restriction, including without limitation the rights
   9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 copies of the Software, and to permit persons to whom the Software is
  11 furnished to do so, subject to the following conditions:
  12
  13 The above copyright notice and this permission notice shall be included in
  14 all copies or substantial portions of the Software.
  15
  16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  19 AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  20 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  21 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22
  23 ******************************************************************/
  24
  25 #ifndef TASKMANAGER_H
  26 #define TASKMANAGER_H
  27
  28 #include <QtCore/QHash>
  29 #include <QtCore/QSet>
  30 #include <QtCore/QVector>
  31
  32 #include <KDE/KSharedPtr>
  33 #include <KDE/KWindowSystem>
  34
  35 class QUuid;
  36
  37 namespace TaskManager
  38 {
  39 typedef QSet<WId> WindowList;
  40
  41 class Task;
  42 typedef KSharedPtr<Task> TaskPtr;
  43 typedef QVector<TaskPtr> TaskList;
  44 typedef QHash<WId, TaskPtr> TaskDict;
  45
  46 class Startup;
  47 typedef KSharedPtr<Startup> StartupPtr;
  48 typedef QVector<StartupPtr> StartupList;
  49
  50 enum TaskChange { TaskUnchanged = 0,
  51                   NameChanged = 1,
  52                   StateChanged = 2,
  53                   DesktopChanged = 32,
  54                   GeometryChanged = 64,
  55                   WindowTypeChanged = 128,
  56                   ActionsChanged = 256,
  57                   TransientsChanged = 512,
  58                   IconChanged = 1024,
  59                   ColorChanged = 2048,
  60                   EverythingChanged = 0xffff
  61                 };
  62 Q_DECLARE_FLAGS(TaskChanges, TaskChange)
  63 } // namespace TaskManager
  64
  65 // Own
  66 #include <taskmanager/startup.h>
  67 #include <taskmanager/task.h>
  68 #include <taskmanager/taskmanager_export.h>
  69
  70 namespace TaskManager
  71 {
  72
  73 /**
  74  * A generic API for task managers. This class provides an easy way to
  75  * build NET compliant task managers. It provides support for startup
  76  * notification, virtual desktops and the full range of WM properties.
  77  *
  78  * @see Task
  79  * @see Startup
  80  */
  81 class TASKMANAGER_EXPORT TaskManager : public QObject
  82 {
  83     Q_OBJECT
  84     Q_PROPERTY( int currentDesktop READ currentDesktop )
  85     Q_PROPERTY( int numberOfDesktops READ numberOfDesktops )
  86
  87 public:
  88     static TaskManager* self();
  89
  90     TaskManager();
  91     ~TaskManager();
  92
  93     /**
  94      * Returns the task for a given WId, or 0 if there is no such task.
  95      */
  96     TaskPtr findTask(WId w);
  97
  98     /**
  99      * Returns the task for a given location, or 0 if there is no such task.
 100      */
 101     TaskPtr findTask(int desktop, const QPoint& p);
 102
 103     /**
 104      * Returns a list of all current tasks.
 105      */
 106     TaskDict tasks() const;
 107
 108     /**
 109      * Returns a list of all current startups.
 110      */
 111     StartupList startups() const;
 112
 113     /**
 114      * Returns the name of the nth desktop.
 115      */
 116     QString desktopName(int n) const;
 117
 118     /**
 119      * Returns the number of virtual desktops.
 120      */
 121     int numberOfDesktops() const;
 122
 123     /**
 124      * Returns the number of the current desktop.
 125      */
 126     int currentDesktop() const;
 127
 128     /**
 129      * Returns true if the specified task is on top.
 130      */
 131     bool isOnTop(const Task*) const;
 132
 133     /**
 134      * Tells the task manager whether or not we care about geometry
 135      * updates. This generates a lot of activity so should only be used
 136      * when necessary.
 137      */
 138     void setTrackGeometry(bool track, const QUuid &token);
 139
 140     /**
 141      * @return true if geometry tracking is on
 142      */
 143     bool trackGeometry() const;
 144
 145     /**
 146     * Returns whether the Window with WId wid is on the screen screen
 147     */
 148     static bool isOnScreen(int screen, const WId wid);
 149
 150 Q_SIGNALS:
 151     /**
 152      * Emitted when a new task has started.
 153      */
 154     void taskAdded(TaskPtr);
 155
 156     /**
 157      * Emitted when a task has terminated.
 158      */
 159     void taskRemoved(TaskPtr);
 160
 161     /**
 162      * Emitted when a new task is expected.
 163      */
 164     void startupAdded(StartupPtr);
 165
 166     /**
 167      * Emitted when a startup item should be removed. This could be because
 168      * the task has started, because it is known to have died, or simply
 169      * as a result of a timeout.
 170      */
 171     void startupRemoved(StartupPtr);
 172
 173     /**
 174      * Emitted when the current desktop changes.
 175      */
 176     void desktopChanged(int desktop);
 177
 178     /**
 179      * Emitted when a window changes desktop.
 180      */
 181     void windowChanged(TaskPtr task, ::TaskManager::TaskChanges change);
 182
 183 protected Q_SLOTS:
 184     //* @internal
 185     void windowAdded(WId);
 186     //* @internal
 187     void windowRemoved(WId);
 188     //* @internal
 189     void windowChanged(WId, unsigned int);
 190
 191     //* @internal
 192     void activeWindowChanged(WId);
 193     //* @internal
 194     void currentDesktopChanged(int);
 195     //* @internal
 196     void killStartup( const KStartupInfoId& );
 197     //* @internal
 198     void killStartup(StartupPtr);
 199
 200     //* @internal
 201     void gotNewStartup( const KStartupInfoId&, const KStartupInfoData& );
 202     //* @internal
 203     void gotStartupChange( const KStartupInfoId&, const KStartupInfoData& );
 204
 205     //* @internal
 206     void taskChanged(::TaskManager::TaskChanges changes);
 207
 208 protected:
 209     void configureStartup();
 210
 211 private:
 212     class Private;
 213     Private * const d;
 214 };
 215
 216 } // TaskManager namespace
 217
 218 Q_DECLARE_OPERATORS_FOR_FLAGS(TaskManager::TaskChanges)
 219
 220 #endif