My Project
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Properties Macros
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 protected:
59  LauncherModelInterface(QObject *parent = 0): QAbstractListModel(parent) {
60  m_roleNames.insert(RoleAppId, "appId");
61  m_roleNames.insert(RoleName, "name");
62  m_roleNames.insert(RoleIcon, "icon");
63  m_roleNames.insert(RolePinned, "pinned");
64  m_roleNames.insert(RoleRunning, "running");
65  m_roleNames.insert(RoleRecent, "recent");
66  m_roleNames.insert(RoleProgress, "progress");
67  m_roleNames.insert(RoleCount, "count");
68  m_roleNames.insert(RoleFocused, "focused");
69  }
71 
72 public:
78  enum Roles {
79  RoleAppId = Qt::UserRole,
80  RoleName,
81  RoleIcon,
82  RolePinned,
83  RoleRunning,
84  RoleRecent,
85  RoleProgress,
86  RoleCount,
87  RoleFocused
88  };
89 
90  virtual ~LauncherModelInterface() {}
91 
98  Q_INVOKABLE virtual void move(int oldIndex, int newIndex) = 0;
99 
108  Q_INVOKABLE virtual unity::shell::launcher::LauncherItemInterface *get(int index) const = 0;
109 
123  Q_INVOKABLE virtual void pin(const QString &appId, int index = -1) = 0;
124 
132  Q_INVOKABLE virtual void requestRemove(const QString &appId) = 0;
133 
134 
141  Q_INVOKABLE virtual void quickListActionInvoked(const QString &appId, int actionIndex) = 0;
142 
143 
149  Q_INVOKABLE virtual void setUser(const QString &username) = 0;
150 
152  virtual unity::shell::application::ApplicationManagerInterface *applicationManager() const = 0;
153  virtual void setApplicationManager(unity::shell::application::ApplicationManagerInterface *applicationManager) = 0;
154 
155  virtual QHash<int, QByteArray> roleNames() const
156  {
157  return m_roleNames;
158  }
160 
161 Q_SIGNALS:
163  void applicationManagerChanged();
165 
166 protected:
168  QHash<int, QByteArray> m_roleNames;
170 
171 };
172 
173 } // namespace launcher
174 } // namespace shell
175 } // namespace unity
176 
177 #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:78
An item presented in the launcher.
Definition: LauncherItemInterface.h:43