My Project
LauncherModelInterface.h
1 /*
2  * Copyright 2013 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_LAUNCHER_LAUNCHERMODELINTERFACE_H
21 #define UNITY_SHELL_LAUNCHER_LAUNCHERMODELINTERFACE_H
22 
23 #include <unity/SymbolExport.h>
24 
25 #include <unity/shell/application/ApplicationManagerInterface.h>
26 
27 #include <QtCore/QAbstractListModel>
28 
29 namespace unity
30 {
31 namespace shell
32 {
33 namespace launcher
34 {
35 
36 class LauncherItemInterface;
37 
43 class UNITY_API LauncherModelInterface: public QAbstractListModel
44 {
45  Q_OBJECT
46 
54  Q_PROPERTY(unity::shell::application::ApplicationManagerInterface* applicationManager
55  READ applicationManager WRITE setApplicationManager NOTIFY applicationManagerChanged)
56 
57 
60  Q_PROPERTY(bool onlyPinned READ onlyPinned WRITE setOnlyPinned NOTIFY onlyPinnedChanged)
61 
62 protected:
64  LauncherModelInterface(QObject *parent = 0): QAbstractListModel(parent) {
65  m_roleNames.insert(RoleAppId, "appId");
66  m_roleNames.insert(RoleName, "name");
67  m_roleNames.insert(RoleIcon, "icon");
68  m_roleNames.insert(RolePinned, "pinned");
69  m_roleNames.insert(RoleRunning, "running");
70  m_roleNames.insert(RoleRecent, "recent");
71  m_roleNames.insert(RoleProgress, "progress");
72  m_roleNames.insert(RoleCount, "count");
73  m_roleNames.insert(RoleCountVisible, "countVisible");
74  m_roleNames.insert(RoleFocused, "focused");
75  m_roleNames.insert(RoleAlerting, "alerting");
76  }
78 
79 public:
85  enum Roles {
86  RoleAppId = Qt::UserRole,
87  RoleName,
88  RoleIcon,
89  RolePinned,
90  RoleRunning,
91  RoleRecent,
92  RoleProgress,
93  RoleCount,
94  RoleCountVisible,
95  RoleFocused,
96  RoleAlerting
97  };
98 
99  virtual ~LauncherModelInterface() {}
100 
107  Q_INVOKABLE virtual void setAlerting(const QString& appId, bool alerting) = 0;
108 
115  Q_INVOKABLE virtual void move(int oldIndex, int newIndex) = 0;
116 
125  Q_INVOKABLE virtual unity::shell::launcher::LauncherItemInterface *get(int index) const = 0;
126 
140  Q_INVOKABLE virtual void pin(const QString &appId, int index = -1) = 0;
141 
149  Q_INVOKABLE virtual void requestRemove(const QString &appId) = 0;
150 
151 
158  Q_INVOKABLE virtual void quickListActionInvoked(const QString &appId, int actionIndex) = 0;
159 
160 
166  Q_INVOKABLE virtual void setUser(const QString &username) = 0;
167 
169  virtual unity::shell::application::ApplicationManagerInterface *applicationManager() const = 0;
170  virtual void setApplicationManager(unity::shell::application::ApplicationManagerInterface *applicationManager) = 0;
171 
172  virtual bool onlyPinned() const = 0;
173  virtual void setOnlyPinned(bool onlyPinned) = 0;
174 
175  virtual QHash<int, QByteArray> roleNames() const
176  {
177  return m_roleNames;
178  }
180 
181 Q_SIGNALS:
183  void applicationManagerChanged();
184  void onlyPinnedChanged();
186 
191  void hint();
192 
193 protected:
195  QHash<int, QByteArray> m_roleNames;
197 
198 };
199 
200 } // namespace launcher
201 } // namespace shell
202 } // namespace unity
203 
204 #endif // UNITY_SHELL_LAUNCHER_LAUNCHERMODELINTERFACE_H
A list of launcher items to be displayed.
Definition: LauncherModelInterface.h:43
The Application manager.
Definition: ApplicationManagerInterface.h:43
Roles
The Roles supported by the model.
Definition: LauncherModelInterface.h:85
Top-level namespace for all things Unity-related.
Definition: Version.h:37
An item presented in the launcher.
Definition: LauncherItemInterface.h:43