git.iko.soy/unity8
on e174ec3 help sign in
unity8/plugins/WindowManager/TopLevelWindowModel.h
260 lines 9.2 kB history raw
1/*
2 * Copyright (C) 2016 Canonical, Ltd.
3 *
4 * This program is free software: you can redistribute it and/or modify it under
5 * the terms of the GNU Lesser General Public License version 3, as published by
6 * the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
10 * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * 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 */
17#ifndef TOPLEVELWINDOWMODEL_H
18#define TOPLEVELWINDOWMODEL_H
20#include <QAbstractListModel>
21#include <QLoggingCategory>
23#include <memory>
25Q_DECLARE_LOGGING_CATEGORY(TOPLEVELWINDOWMODEL)
27class Window;
28class Workspace;
30namespace miral { class Workspace; }
32namespace unity {
33 namespace shell {
34 namespace application {
35 class ApplicationInfoInterface;
36 class ApplicationManagerInterface;
37 class MirSurfaceInterface;
38 class SurfaceManagerInterface;
39 }
40 }
43/**
44 * @brief A model of top-level surfaces
45 *
46 * It's an abstraction of top-level application windows.
47 *
48 * When an entry first appears, it normaly doesn't have a surface yet, meaning that the application is
49 * still starting up. A shell should then display a splash screen or saved screenshot of the application
50 * until its surface comes up.
51 *
52 * As applications can have multiple surfaces and you can also have entries without surfaces at all,
53 * the only way to unambiguously refer to an entry in this model is through its id.
54 */
55class TopLevelWindowModel : public QAbstractListModel
57 Q_OBJECT
59 /**
60 * @brief Number of top-level surfaces in this model
61 *
62 * This is the same as rowCount, added in order to keep compatibility with QML ListModels.
63 */
64 Q_PROPERTY(int count READ rowCount NOTIFY countChanged)
66 /**
67 * @brief The input method surface, if any
68 *
69 * The surface of a onscreen keyboard (akak "virtual keyboard") would be kept here and not in the model itself.
70 */
71 Q_PROPERTY(unity::shell::application::MirSurfaceInterface* inputMethodSurface READ inputMethodSurface NOTIFY inputMethodSurfaceChanged)
73 /**
74 * @brief The currently focused window, if any
75 */
76 Q_PROPERTY(Window* focusedWindow READ focusedWindow NOTIFY focusedWindowChanged)
78 /**
79 The id to be used on the next entry created
80 Useful for tests
81 */
82 Q_PROPERTY(int nextId READ nextId NOTIFY nextIdChanged)
84public:
85 /**
86 * @brief The Roles supported by the model
87 *
88 * WindowRole - A Window.
89 * ApplicationRole - An ApplicationInfoInterface
90 */
91 enum Roles {
92 WindowRole = Qt::UserRole,
93 ApplicationRole = Qt::UserRole + 1,
94 };
96 TopLevelWindowModel(Workspace* workspace);
98 // From QAbstractItemModel
99 int rowCount(const QModelIndex &parent = QModelIndex()) const override;
100 QVariant data(const QModelIndex& index, int role) const override;
101 QHash<int, QByteArray> roleNames() const override {
102 QHash<int, QByteArray> roleNames { {WindowRole, "window"},
103 {ApplicationRole, "application"} };
104 return roleNames;
105 }
107 // Own API;
109 unity::shell::application::MirSurfaceInterface* inputMethodSurface() const;
110 Window* focusedWindow() const;
112 int nextId() const { return m_nextId; }
114public:
115 /**
116 * @brief Returns the surface at the given index
117 *
118 * It will be a nullptr if the application is still starting up and thus hasn't yet created
119 * and drawn into a surface.
120 *
121 * Same as windowAt(index).surface()
122 */
123 Q_INVOKABLE unity::shell::application::MirSurfaceInterface *surfaceAt(int index) const;
125 /**
126 * @brief Returns the window at the given index
127 *
128 * Will always be valid
129 */
130 Q_INVOKABLE Window *windowAt(int index) const;
132 /**
133 * @brief Returns the application at the given index
134 */
135 Q_INVOKABLE unity::shell::application::ApplicationInfoInterface *applicationAt(int index) const;
137 /**
138 * @brief Returns the unique id of the element at the given index
139 */
140 Q_INVOKABLE int idAt(int index) const;
142 /**
143 * @brief Returns the index where the row with the given id is located
144 *
145 * Returns -1 if there's no row with the given id.
146 */
147 Q_INVOKABLE int indexForId(int id) const;
149 /**
150 * @brief Raises the row with the given id to the top of the window stack (index == count-1)
151 */
152 Q_INVOKABLE void raiseId(int id);
154Q_SIGNALS:
155 void countChanged();
156 void inputMethodSurfaceChanged(unity::shell::application::MirSurfaceInterface* inputMethodSurface);
157 void focusedWindowChanged(Window *focusedWindow);
159 /**
160 * @brief Emitted when the list changes
161 *
162 * Emitted when model gains an element, loses an element or when elements exchange positions.
163 */
164 void listChanged();
166 void nextIdChanged();
168private Q_SLOTS:
169 void setApplicationManager(unity::shell::application::ApplicationManagerInterface*);
170 void setSurfaceManager(unity::shell::application::SurfaceManagerInterface*);
172 void onSurfaceCreated(unity::shell::application::MirSurfaceInterface *surface);
173 void onSurfacesAddedToWorkspace(const std::shared_ptr<miral::Workspace>& workspace,
174 const QVector<unity::shell::application::MirSurfaceInterface*> surfaces);
175 void onSurfacesAboutToBeRemovedFromWorkspace(const std::shared_ptr<miral::Workspace>& workspace,
176 const QVector<unity::shell::application::MirSurfaceInterface*> surfaces);
177 void onSurfacesRaised(const QVector<unity::shell::application::MirSurfaceInterface*> &surfaces);
179 void onModificationsStarted();
180 void onModificationsEnded();
182private:
183 void doRaiseId(int id);
184 int generateId();
185 int nextFreeId(int candidateId, const int latestId);
186 int nextId(int id) const;
187 QString toString();
188 int indexOf(unity::shell::application::MirSurfaceInterface *surface);
190 void setInputMethodWindow(Window *window);
191 void setFocusedWindow(Window *window);
192 void removeInputMethodWindow();
193 int findIndexOf(const unity::shell::application::MirSurfaceInterface *surface) const;
194 void removeAt(int index);
196 void addApplication(unity::shell::application::ApplicationInfoInterface *application);
197 void removeApplication(unity::shell::application::ApplicationInfoInterface *application);
199 void prependPlaceholder(unity::shell::application::ApplicationInfoInterface *application);
200 void prependSurface(unity::shell::application::MirSurfaceInterface *surface,
201 unity::shell::application::ApplicationInfoInterface *application);
202 void prependSurfaceHelper(unity::shell::application::MirSurfaceInterface *surface,
203 unity::shell::application::ApplicationInfoInterface *application);
205 void connectWindow(Window *window);
206 void connectSurface(unity::shell::application::MirSurfaceInterface *surface);
208 void onSurfaceDied(unity::shell::application::MirSurfaceInterface *surface);
209 void onSurfaceDestroyed(unity::shell::application::MirSurfaceInterface *surface);
211 void move(int from, int to);
213 void activateEmptyWindow(Window *window);
215 void activateTopMostWindowWithoutId(int forbiddenId);
216 void refreshWindows();
217 void clear();
219 Window *createWindow(unity::shell::application::MirSurfaceInterface *surface);
221 struct ModelEntry {
222 ModelEntry() {}
223 ModelEntry(Window *window,
224 unity::shell::application::ApplicationInfoInterface *application)
225 : window(window), application(application) {}
226 Window *window{nullptr};
227 unity::shell::application::ApplicationInfoInterface *application{nullptr};
228 bool removeOnceSurfaceDestroyed{false};
229 };
231 QVector<ModelEntry> m_windowModel;
232 Window* m_inputMethodWindow{nullptr};
233 Window* m_focusedWindow{nullptr};
234 Workspace* m_workspace{nullptr};
235 // track all the surfaces we've been told about.
236 QSet<unity::shell::application::MirSurfaceInterface*> m_allSurfaces;
238 int m_nextId{1};
239 // Just something big enough that we don't risk running out of unused id numbers.
240 // Not sure if QML int type supports something close to std::numeric_limits<int>::max() and
241 // there's no reason to try out its limits.
242 static const int m_maxId{1000000};
244 unity::shell::application::ApplicationManagerInterface* m_applicationManager{nullptr};
245 unity::shell::application::SurfaceManagerInterface *m_surfaceManager{nullptr};
247 enum ModelState {
248 IdleState,
249 InsertingState,
250 RemovingState,
251 MovingState,
252 ResettingState
253 };
254 ModelState m_modelState{IdleState};
256 // Valid between modificationsStarted and modificationsEnded
257 bool m_focusedWindowCleared{false};
258};
260#endif // TOPLEVELWINDOWMODEL_H