summaryrefslogtreecommitdiffstats
path: root/src/compositor/compositor_api/qwaylandsurface.h
blob: 2295a3a346ed7d6a5b2fa156dc2faded20cf05f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/****************************************************************************
**
** Copyright (C) 2014-2015 Pier Luigi Fiorini <pierluigi.fiorini@gmail.com>
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtWaylandCompositor module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QWAYLANDSURFACE_H
#define QWAYLANDSURFACE_H

#include <QtCompositor/qwaylandexport.h>
#include <QtCompositor/qwaylandextension.h>

#include <QtCore/QScopedPointer>
#include <QtGui/QImage>
#include <QtGui/QWindow>
#include <QtCore/QVariantMap>

struct wl_client;
struct wl_resource;

QT_BEGIN_NAMESPACE

class QTouchEvent;
class QWaylandClient;
class QWaylandSurfacePrivate;
class QWaylandCompositor;
class QWaylandBufferRef;
class QWaylandView;
class QWaylandSurfaceOp;
class QWaylandOutput;

namespace QtWayland {
class Surface;
class SurfacePrivate;
class ExtendedSurface;
}

class QWaylandSurfaceEnterEventPrivate;

class Q_COMPOSITOR_EXPORT QWaylandSurfaceEnterEvent : public QEvent
{
public:
    QWaylandSurfaceEnterEvent(QWaylandOutput *output);
    ~QWaylandSurfaceEnterEvent();

    QWaylandOutput *output() const;

    static const QEvent::Type WaylandSurfaceEnter;

private:
    QWaylandSurfaceEnterEventPrivate *d;
};

class QWaylandSurfaceLeaveEventPrivate;

class Q_COMPOSITOR_EXPORT QWaylandSurfaceLeaveEvent : public QEvent
{
public:
    QWaylandSurfaceLeaveEvent(QWaylandOutput *output);
    ~QWaylandSurfaceLeaveEvent();

    QWaylandOutput *output() const;

    static const QEvent::Type WaylandSurfaceLeave;

private:
    QWaylandSurfaceLeaveEventPrivate *d;
};

class Q_COMPOSITOR_EXPORT QWaylandSurface : public QObject, public QWaylandExtensionContainer
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QWaylandSurface)
    Q_PROPERTY(QWaylandClient *client READ client CONSTANT)
    Q_PROPERTY(QSize size READ size NOTIFY sizeChanged)
    Q_PROPERTY(Qt::ScreenOrientation contentOrientation READ contentOrientation NOTIFY contentOrientationChanged)
    Q_PROPERTY(QString className READ className NOTIFY classNameChanged)
    Q_PROPERTY(QString title READ title NOTIFY titleChanged)
    Q_PROPERTY(QWaylandOutput *primaryOutput READ primaryOutput WRITE setPrimaryOutput NOTIFY primaryOutputChanged)
    Q_PROPERTY(QWaylandSurface::Origin origin READ origin NOTIFY originChanged)

public:
    enum Origin {
        OriginTopLeft,
        OriginBottomLeft
    };

    QWaylandSurface(wl_client *client, quint32 id, int version, QWaylandCompositor *compositor);
    virtual ~QWaylandSurface();

    QWaylandClient *client() const;

    QWaylandSurface *parentSurface() const;
    QLinkedList<QWaylandSurface *> subSurfaces() const;

    bool visible() const;
    bool isMapped() const;

    QSize size() const;

    Qt::ScreenOrientation contentOrientation() const;

    Origin origin() const;

    QtWayland::Surface *handle();

    QByteArray authenticationToken() const;

    QWaylandCompositor *compositor() const;

    QWaylandOutput *primaryOutput() const;
    void setPrimaryOutput(QWaylandOutput *output);

    QString className() const;

    QString title() const;

    bool hasInputPanelSurface() const;

    bool inputRegionContains(const QPoint &p) const;

    Q_INVOKABLE void destroy();

    Q_INVOKABLE void sendFrameCallbacks();

    void ref();
    void deref();
    void setMapped(bool mapped);

    QList<QWaylandView *> views() const;

    static QWaylandSurface *fromResource(::wl_resource *resource);
    struct wl_resource *resource() const;

    void enter(QWaylandOutput *output);
    void leave(QWaylandOutput *output);

    void markAsCursorSurface(bool cursorSurface);
    bool isCursorSurface() const;

public Q_SLOTS:
    void updateSelection();

protected:
    QWaylandSurface(QWaylandSurfacePrivate *dptr);

Q_SIGNALS:
    void mapped();
    void unmapped();
    void damaged(const QRegion &rect);
    void parentChanged(QWaylandSurface *newParent, QWaylandSurface *oldParent);
    void sizeChanged();
    void offsetForNextFrame(const QPoint &offset);
    void contentOrientationChanged();
    void extendedSurfaceReady();
    void classNameChanged();
    void titleChanged();
    void raiseRequested();
    void lowerRequested();
    void pong();
    void surfaceDestroyed();
    void primaryOutputChanged(QWaylandOutput *newOutput, QWaylandOutput *oldOutput);
    void originChanged();

    void configure(bool hasBuffer);
    void redraw();

    friend class QtWayland::Surface;
};

QT_END_NAMESPACE

#endif // QWAYLANDSURFACE_H