My Project
ApplicationInfoInterface.h
1 /*
2  * Copyright 2013,2015,2016 Canonical Ltd.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License as published by
6  * the Free Software Foundation; version 3.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  */
16 
17 #ifndef UNITY_SHELL_APPLICATION_APPLICATIONINFOINTERFACE_H
18 #define UNITY_SHELL_APPLICATION_APPLICATIONINFOINTERFACE_H
19 
20 #include <unity/SymbolExport.h>
21 
22 #include <QtCore/QObject>
23 #include <QtCore/QUrl>
24 #include <QColor>
25 #include <QSize>
26 
27 namespace unity
28 {
29 namespace shell
30 {
31 namespace application
32 {
33 
34 class MirSurfaceListInterface;
35 
43 class UNITY_API ApplicationInfoInterface: public QObject
44 {
45  Q_OBJECT
46 
47  Q_ENUMS(Stage)
48  Q_ENUMS(State)
49  Q_ENUMS(RequestedState)
50 
51 
57  Q_PROPERTY(QString appId READ appId CONSTANT)
58 
64  Q_PROPERTY(QString name READ name NOTIFY nameChanged)
65 
72  Q_PROPERTY(QString comment READ comment NOTIFY commentChanged)
73 
79  Q_PROPERTY(QUrl icon READ icon NOTIFY iconChanged)
80 
86  Q_PROPERTY(Stage stage READ stage WRITE setStage NOTIFY stageChanged)
87 
93  Q_PROPERTY(State state READ state NOTIFY stateChanged)
94 
98  Q_PROPERTY(RequestedState requestedState READ requestedState WRITE setRequestedState NOTIFY requestedStateChanged)
99 
105  Q_PROPERTY(bool focused READ focused NOTIFY focusedChanged)
106 
116  Q_PROPERTY(QString splashTitle READ splashTitle CONSTANT)
117 
128  Q_PROPERTY(QUrl splashImage READ splashImage CONSTANT)
129 
146  Q_PROPERTY(bool splashShowHeader READ splashShowHeader CONSTANT)
147 
157  Q_PROPERTY(QColor splashColor READ splashColor CONSTANT)
158 
170  Q_PROPERTY(QColor splashColorHeader READ splashColorHeader CONSTANT)
171 
183  Q_PROPERTY(QColor splashColorFooter READ splashColorFooter CONSTANT)
184 
189  Q_PROPERTY(Qt::ScreenOrientations supportedOrientations READ supportedOrientations CONSTANT)
190 
203  Q_PROPERTY(bool rotatesWindowContents READ rotatesWindowContents CONSTANT)
204 
208  Q_PROPERTY(bool isTouchApp READ isTouchApp CONSTANT)
209 
215  Q_PROPERTY(bool exemptFromLifecycle READ exemptFromLifecycle WRITE setExemptFromLifecycle NOTIFY exemptFromLifecycleChanged)
216 
220  Q_PROPERTY(QSize initialSurfaceSize READ initialSurfaceSize WRITE setInitialSurfaceSize NOTIFY initialSurfaceSizeChanged)
221 
225  Q_PROPERTY(unity::shell::application::MirSurfaceListInterface* surfaceList READ surfaceList CONSTANT)
226 
230  Q_PROPERTY(unity::shell::application::MirSurfaceListInterface* promptSurfaceList READ promptSurfaceList CONSTANT)
231 
232 protected:
234  ApplicationInfoInterface(const QString &appId, QObject* parent = 0): QObject(parent) { Q_UNUSED(appId) }
236 
237 public:
246  enum Stage {
247  MainStage,
248  SideStage
249  };
250 
263  enum State {
264  Starting,
265  Running,
266  Suspended,
267  Stopped
268  };
269 
278  RequestedRunning = Running,
279  RequestedSuspended = Suspended
280  };
281 
283  virtual ~ApplicationInfoInterface() {}
284 
285  virtual QString appId() const = 0;
286  virtual QString name() const = 0;
287  virtual QString comment() const = 0;
288  virtual QUrl icon() const = 0;
289  virtual Stage stage() const = 0;
290  virtual void setStage(Stage) = 0;
291  virtual State state() const = 0;
292  virtual RequestedState requestedState() const = 0;
293  virtual void setRequestedState(RequestedState) = 0;
294  virtual bool focused() const = 0;
295  virtual QString splashTitle() const = 0;
296  virtual QUrl splashImage() const = 0;
297  virtual bool splashShowHeader() const = 0;
298  virtual QColor splashColor() const = 0;
299  virtual QColor splashColorHeader() const = 0;
300  virtual QColor splashColorFooter() const = 0;
301  virtual Qt::ScreenOrientations supportedOrientations() const = 0;
302  virtual bool rotatesWindowContents() const = 0;
303  virtual bool isTouchApp() const = 0;
304  virtual bool exemptFromLifecycle() const = 0;
305  virtual void setExemptFromLifecycle(bool) = 0;
306  virtual QSize initialSurfaceSize() const = 0;
307  virtual void setInitialSurfaceSize(const QSize &size) = 0;
308  virtual MirSurfaceListInterface* surfaceList() = 0;
309  virtual MirSurfaceListInterface* promptSurfaceList() = 0;
311 
312 Q_SIGNALS:
314  void nameChanged(const QString &name);
315  void commentChanged(const QString &comment);
316  void iconChanged(const QUrl &icon);
317  void stageChanged(Stage stage);
318  void stateChanged(State state);
319  void requestedStateChanged(RequestedState value);
320  void focusedChanged(bool focused);
321  void exemptFromLifecycleChanged(bool exemptFromLifecycle);
322  void initialSurfaceSizeChanged(const QSize &size);
324 
328  void focusRequested();
329 };
330 
331 } // namespace application
332 } // namespace shell
333 } // namespace unity
334 
336 
337 #endif // UNITY_SHELL_APPLICATIONMANAGER_APPLICATIONINFOINTERFACE_H
Top-level namespace for all things Unity-related.
Definition: Version.h:37
RequestedState
The desired state of an application.
Definition: ApplicationInfoInterface.h:277
Interface for a list model of MirSurfaces.
Definition: MirSurfaceListInterface.h:31
Stage
A enum that defines a stage.
Definition: ApplicationInfoInterface.h:246
State
An application&#39;s state.
Definition: ApplicationInfoInterface.h:263
A class that holds information about applications.
Definition: ApplicationInfoInterface.h:43