My Project
MirSurfaceInterface.h
1 /*
2  * Copyright (C) 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 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 General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  */
16 
17 #ifndef UNITY_SHELL_APPLICATION_MIRSURFACE_H
18 #define UNITY_SHELL_APPLICATION_MIRSURFACE_H
19 
20 #include <QObject>
21 #include <QRect>
22 #include <QSize>
23 
24 #include "Mir.h"
25 
26 namespace unity
27 {
28 namespace shell
29 {
30 namespace application
31 {
32 
33 class MirSurfaceListInterface;
34 
41 class MirSurfaceInterface : public QObject
42 {
43  Q_OBJECT
44 
48  Q_PROPERTY(Mir::Type type READ type NOTIFY typeChanged)
49 
50 
53  Q_PROPERTY(QString name READ name NOTIFY nameChanged)
54 
58  Q_PROPERTY(QString persistentId READ persistentId CONSTANT)
59 
63  Q_PROPERTY(QPoint position READ position NOTIFY positionChanged)
64 
68  Q_PROPERTY(QPoint requestedPosition READ requestedPosition WRITE setRequestedPosition NOTIFY requestedPositionChanged)
69 
73  Q_PROPERTY(QSize size READ size NOTIFY sizeChanged)
74 
78  Q_PROPERTY(Mir::State state READ state NOTIFY stateChanged)
79 
84  Q_PROPERTY(bool live READ live NOTIFY liveChanged)
85 
89  Q_PROPERTY(bool visible READ visible NOTIFY visibleChanged)
90 
96  Q_PROPERTY(Mir::OrientationAngle orientationAngle READ orientationAngle WRITE setOrientationAngle
97  NOTIFY orientationAngleChanged DESIGNABLE false)
98 
103  Q_PROPERTY(int minimumWidth READ minimumWidth NOTIFY minimumWidthChanged)
104 
109  Q_PROPERTY(int minimumHeight READ minimumHeight NOTIFY minimumHeightChanged)
110 
115  Q_PROPERTY(int maximumWidth READ maximumWidth NOTIFY maximumWidthChanged)
116 
121  Q_PROPERTY(int maximumHeight READ maximumHeight NOTIFY maximumHeightChanged)
122 
127  Q_PROPERTY(int widthIncrement READ widthIncrement NOTIFY widthIncrementChanged)
128 
133  Q_PROPERTY(int heightIncrement READ heightIncrement NOTIFY heightIncrementChanged)
134 
138  Q_PROPERTY(Mir::ShellChrome shellChrome READ shellChrome NOTIFY shellChromeChanged)
139 
144  Q_PROPERTY(QString keymap READ keymap WRITE setKeymap NOTIFY keymapChanged)
145 
151  Q_PROPERTY(bool focused READ focused NOTIFY focusedChanged)
152 
158  Q_PROPERTY(QRect inputBounds READ inputBounds NOTIFY inputBoundsChanged)
159 
165  Q_PROPERTY(bool confinesMousePointer READ confinesMousePointer NOTIFY confinesMousePointerChanged)
166 
167 public:
169  MirSurfaceInterface(QObject *parent = nullptr) : QObject(parent) {}
170  virtual ~MirSurfaceInterface() {}
171 
172  virtual Mir::Type type() const = 0;
173 
174  virtual QString name() const = 0;
175 
176  virtual QString persistentId() const = 0;
177 
178  virtual QPoint position() const = 0;
179 
180  virtual QSize size() const = 0;
181  virtual void resize(int width, int height) = 0;
182  virtual void resize(const QSize &size) = 0;
183 
184  virtual Mir::State state() const = 0;
185 
186  virtual bool live() const = 0;
187 
188  virtual bool visible() const = 0;
189 
190  virtual Mir::OrientationAngle orientationAngle() const = 0;
191  virtual void setOrientationAngle(Mir::OrientationAngle angle) = 0;
192 
193  virtual int minimumWidth() const = 0;
194  virtual int minimumHeight() const = 0;
195  virtual int maximumWidth() const = 0;
196  virtual int maximumHeight() const = 0;
197  virtual int widthIncrement() const = 0;
198  virtual int heightIncrement() const = 0;
199 
200  virtual void setKeymap(const QString &) = 0;
201  virtual QString keymap() const = 0;
202 
203  virtual Mir::ShellChrome shellChrome() const = 0;
204 
205  virtual bool focused() const = 0;
206 
207  virtual QRect inputBounds() const = 0;
208 
209  virtual bool confinesMousePointer() const = 0;
210 
211  virtual QPoint requestedPosition() const = 0;
212  virtual void setRequestedPosition(const QPoint &) = 0;
214 
219  Q_INVOKABLE virtual void close() = 0;
220 
226  Q_INVOKABLE virtual void activate() = 0;
227 
228 public Q_SLOTS:
232  virtual void requestState(Mir::State state) = 0;
233 
234 Q_SIGNALS:
236  void typeChanged(Mir::Type value);
237  void liveChanged(bool value);
238  void visibleChanged(bool visible);
239  void stateChanged(Mir::State value);
240  void orientationAngleChanged(Mir::OrientationAngle value);
241  void positionChanged(QPoint position);
242  void requestedPositionChanged(QPoint position);
243  void sizeChanged(const QSize &value);
244  void nameChanged(const QString &name);
245  void minimumWidthChanged(int value);
246  void minimumHeightChanged(int value);
247  void maximumWidthChanged(int value);
248  void maximumHeightChanged(int value);
249  void widthIncrementChanged(int value);
250  void heightIncrementChanged(int value);
251  void shellChromeChanged(Mir::ShellChrome value);
252  void keymapChanged(const QString &value);
253  void focusedChanged(bool value);
254  void inputBoundsChanged(QRect value);
255  void confinesMousePointerChanged(bool value);
257 
263  void focusRequested();
264 
268  void closeRequested();
269 };
270 
271 } // namespace application
272 } // namespace shell
273 } // namespace unity
274 
276 
277 #endif // UNITY_SHELL_APPLICATION_MIRSURFACE_H
int heightIncrement
The requested height increment for the surface Zero if not set.
Definition: MirSurfaceInterface.h:133
virtual void requestState(Mir::State state)=0
Requests a change to the specified state.
int minimumHeight
The requested minimum height for the surface Zero if not set.
Definition: MirSurfaceInterface.h:109
Type
Surface type.
Definition: Mir.h:45
Mir::Type type
The surface type.
Definition: MirSurfaceInterface.h:48
int minimumWidth
The requested minimum width for the surface Zero if not set.
Definition: MirSurfaceInterface.h:103
State
Surface state.
Definition: Mir.h:61
QString name
Name of the surface, given by the client application.
Definition: MirSurfaceInterface.h:53
virtual Q_INVOKABLE void close()=0
Sends a close request.
Mir::OrientationAngle orientationAngle
Orientation angle of the surface.
Definition: MirSurfaceInterface.h:97
virtual Q_INVOKABLE void activate()=0
Activates this surface.
ShellChrome
Shell chrome.
Definition: Mir.h:91
Top-level namespace for all things Unity-related.
Definition: Version.h:37
QString keymap
The requested keymap for this surface Its format is "layout+variant".
Definition: MirSurfaceInterface.h:144
bool focused
Whether the surface is focused.
Definition: MirSurfaceInterface.h:151
QSize size
Size of the current surface buffer, in pixels.
Definition: MirSurfaceInterface.h:73
int maximumWidth
The requested maximum width for the surface Zero if not set.
Definition: MirSurfaceInterface.h:115
Mir::State state
State of the surface.
Definition: MirSurfaceInterface.h:78
bool confinesMousePointer
Whether the surface wants to confine the mouse pointer within its boundaries.
Definition: MirSurfaceInterface.h:165
void focusRequested()
Emitted in response to a requestFocus() call.
int maximumHeight
The requested maximum height for the surface Zero if not set.
Definition: MirSurfaceInterface.h:121
OrientationAngle
Surface orientation angle.
Definition: Mir.h:81
Acting mostly as a namespace to hold enums and such for use in QML.
Definition: Mir.h:25
int widthIncrement
The requested width increment for the surface Zero if not set.
Definition: MirSurfaceInterface.h:127
QPoint position
Position of the current surface buffer, in pixels.
Definition: MirSurfaceInterface.h:63
QString persistentId
Persistent Id of the surface.
Definition: MirSurfaceInterface.h:58
QRect inputBounds
Input bounds.
Definition: MirSurfaceInterface.h:158
bool live
True if it has a mir client bound to it. A "zombie" (live == false) surface never becomes alive again...
Definition: MirSurfaceInterface.h:84
void closeRequested()
Emitted when close() is called.
bool visible
Visibility of the surface.
Definition: MirSurfaceInterface.h:89
Mir::ShellChrome shellChrome
The Shell chrome mode.
Definition: MirSurfaceInterface.h:138
Holds a Mir surface. Pretty much an opaque class.
Definition: MirSurfaceInterface.h:41
QPoint requestedPosition
Requested position of the current surface buffer, in pixels.
Definition: MirSurfaceInterface.h:68