My Project
ApplicationManagerInterface.h
1 /*
2  * Copyright 2013,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  * Authors:
17  * Michael Zanetti <michael.zanetti@canonical.com>
18  */
19 
20 #ifndef UNITY_SHELL_APPLICATION_APPLICATIONMANAGERINTERFACE_H
21 #define UNITY_SHELL_APPLICATION_APPLICATIONMANAGERINTERFACE_H
22 
23 #include <unity/SymbolExport.h>
24 
25 #include <QtCore/QObject>
26 #include <QtCore/QAbstractListModel>
27 
28 namespace unity
29 {
30 namespace shell
31 {
32 namespace application
33 {
34 
35 class ApplicationInfoInterface;
36 class MirSurfaceInterface;
37 
44 class UNITY_API ApplicationManagerInterface: public QAbstractListModel
45 {
46  Q_OBJECT
47  Q_ENUMS(Roles)
48 
49 
54  Q_PROPERTY(int count READ count NOTIFY countChanged)
55 
61  Q_PROPERTY(QString focusedApplicationId READ focusedApplicationId NOTIFY focusedApplicationIdChanged)
62 
63 protected:
65  ApplicationManagerInterface(QObject* parent = 0): QAbstractListModel(parent)
66  {
67  m_roleNames.insert(RoleAppId, "appId");
68  m_roleNames.insert(RoleName, "name");
69  m_roleNames.insert(RoleComment, "comment");
70  m_roleNames.insert(RoleIcon, "icon");
71  m_roleNames.insert(RoleState, "state");
72  m_roleNames.insert(RoleFocused, "focused");
73  m_roleNames.insert(RoleIsTouchApp, "isTouchApp");
74  m_roleNames.insert(RoleExemptFromLifecycle, "exemptFromLifecycle");
75  m_roleNames.insert(RoleApplication, "application");
76 
77  connect(this, SIGNAL(rowsInserted(QModelIndex, int, int)), SIGNAL(countChanged()));
78  connect(this, SIGNAL(rowsRemoved(QModelIndex, int, int)), SIGNAL(countChanged()));
79  connect(this, SIGNAL(modelReset()), SIGNAL(countChanged()));
80  connect(this, SIGNAL(layoutChanged()), SIGNAL(countChanged()));
81  }
83 
84 public:
90  enum Roles {
91  RoleAppId = Qt::UserRole,
92  RoleName,
93  RoleComment,
94  RoleIcon,
95  RoleState,
96  RoleFocused,
97  RoleIsTouchApp,
98  RoleExemptFromLifecycle,
99  RoleApplication,
100  };
101 
103  virtual ~ApplicationManagerInterface() {}
104 
105  QHash<int, QByteArray> roleNames() const override
106  {
107  return m_roleNames;
108  }
109 
110  int count() const {
111  return rowCount();
112  }
113 
114  virtual QString focusedApplicationId() const = 0;
115 
117 
126  Q_INVOKABLE virtual unity::shell::application::ApplicationInfoInterface *get(int index) const = 0;
127 
136  Q_INVOKABLE virtual unity::shell::application::ApplicationInfoInterface *findApplication(const QString &appId) const = 0;
137 
138  /*
139  * @brief Returns the AplicationInfo with the given surface
140  */
141  virtual ApplicationInfoInterface *findApplicationWithSurface(MirSurfaceInterface* surface) const = 0;
142 
151  Q_INVOKABLE virtual bool requestFocusApplication(const QString &appId) = 0;
152 
160  Q_INVOKABLE virtual unity::shell::application::ApplicationInfoInterface *startApplication(const QString &appId, const QStringList &arguments) = 0;
161 
168  Q_INVOKABLE virtual bool stopApplication(const QString &appId) = 0;
169 
170 Q_SIGNALS:
172  void countChanged();
174 
181  void focusRequested(const QString &appId);
182 
186  void focusedApplicationIdChanged();
187 
188 protected:
190  QHash<int, QByteArray> m_roleNames;
192 };
193 
194 } // namespace application
195 } // namespace shell
196 } // namespace unity
197 
198 #endif // UNITY_SHELL_APPLICATIONMANAGER_APPLICATIONINFO_H
The Application manager.
Definition: ApplicationManagerInterface.h:44
Roles
The Roles supported by the model.
Definition: ApplicationManagerInterface.h:90
Top-level namespace for all things Unity-related.
Definition: Version.h:37
Holds a Mir surface. Pretty much an opaque class.
Definition: MirSurfaceInterface.h:41
A class that holds information about applications.
Definition: ApplicationInfoInterface.h:43