Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
qwaylandsurface.h
Go to the documentation of this file.
1// Copyright (C) 2017-2015 Pier Luigi Fiorini <pierluigi.fiorini@gmail.com>
2// Copyright (C) 2017 The Qt Company Ltd.
3// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
4
5#ifndef QWAYLANDSURFACE_H
6#define QWAYLANDSURFACE_H
7
8#include <QtWaylandCompositor/qtwaylandcompositorglobal.h>
9#include <QtWaylandCompositor/qwaylandcompositor.h>
10#include <QtWaylandCompositor/qwaylandcompositorextension.h>
11#include <QtWaylandCompositor/qwaylandclient.h>
12#include <QtWaylandCompositor/qwaylanddrag.h>
13
14#include <QtCore/QScopedPointer>
15#include <QtGui/QImage>
16#include <QtGui/QWindow>
17#include <QtCore/QVariantMap>
18
19struct wl_client;
20struct wl_resource;
21
22QT_BEGIN_NAMESPACE
23
24class QTouchEvent;
25class QWaylandSurfacePrivate;
26class QWaylandBufferRef;
27class QWaylandView;
28class QWaylandInputMethodControl;
29
30class QWaylandSurfaceRole
31{
32public:
33 QWaylandSurfaceRole(const QByteArray &n) : m_name(n) {}
34
35 const QByteArray name() { return m_name; }
36
37private:
38 QByteArray m_name;
39};
40
41class Q_WAYLANDCOMPOSITOR_EXPORT QWaylandSurface : public QWaylandObject
42{
43 Q_OBJECT
44 Q_DECLARE_PRIVATE(QWaylandSurface)
45 Q_PROPERTY(QWaylandClient *client READ client CONSTANT)
46 Q_PROPERTY(QRectF sourceGeometry READ sourceGeometry NOTIFY sourceGeometryChanged REVISION(1, 13))
47 Q_PROPERTY(QSize destinationSize READ destinationSize NOTIFY destinationSizeChanged REVISION(1, 13))
48 Q_PROPERTY(QSize bufferSize READ bufferSize NOTIFY bufferSizeChanged REVISION(1, 13))
49 Q_PROPERTY(int bufferScale READ bufferScale NOTIFY bufferScaleChanged)
50 Q_PROPERTY(Qt::ScreenOrientation contentOrientation READ contentOrientation NOTIFY contentOrientationChanged)
51 Q_PROPERTY(QWaylandSurface::Origin origin READ origin NOTIFY originChanged)
52 Q_PROPERTY(bool hasContent READ hasContent NOTIFY hasContentChanged)
53 Q_PROPERTY(bool cursorSurface READ isCursorSurface WRITE markAsCursorSurface NOTIFY cursorSurfaceChanged)
54 Q_PROPERTY(bool inhibitsIdle READ inhibitsIdle NOTIFY inhibitsIdleChanged REVISION(1, 14))
55 Q_PROPERTY(bool isOpaque READ isOpaque NOTIFY isOpaqueChanged REVISION(6, 4))
56 Q_MOC_INCLUDE("qwaylanddrag.h")
57 Q_MOC_INCLUDE("qwaylandcompositor.h")
58
59 QML_NAMED_ELEMENT(WaylandSurfaceBase)
60 QML_ADDED_IN_VERSION(1, 0)
61 QML_UNCREATABLE("Cannot create instance of WaylandSurfaceBase, use WaylandSurface instead")
62public:
63 enum Origin {
64 OriginTopLeft,
65 OriginBottomLeft
66 };
67 Q_ENUM(Origin)
68
69 QWaylandSurface();
70 QWaylandSurface(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version);
71 ~QWaylandSurface() override;
72
73 Q_INVOKABLE void initialize(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version);
74 bool isInitialized() const;
75
76 QWaylandClient *client() const;
77 ::wl_client *waylandClient() const;
78
79 bool setRole(QWaylandSurfaceRole *role, wl_resource *errorResource, uint32_t errorCode);
80 QWaylandSurfaceRole *role() const;
81
82 bool hasContent() const;
83
84 QRectF sourceGeometry() const;
85 QSize destinationSize() const;
86 QSize bufferSize() const;
87 int bufferScale() const;
88
89 Qt::ScreenOrientation contentOrientation() const;
90
91 Origin origin() const;
92
93 QWaylandCompositor *compositor() const;
94
95 bool inputRegionContains(const QPoint &p) const;
96 bool inputRegionContains(const QPointF &position) const;
97
98 Q_INVOKABLE void destroy();
99 Q_INVOKABLE bool isDestroyed() const;
100
101 Q_INVOKABLE void frameStarted();
102 Q_INVOKABLE void sendFrameCallbacks();
103
104 QWaylandView *primaryView() const;
105 void setPrimaryView(QWaylandView *view);
106
107 QList<QWaylandView *> views() const;
108
109 static QWaylandSurface *fromResource(::wl_resource *resource);
110 struct wl_resource *resource() const;
111
112 void markAsCursorSurface(bool cursorSurface);
113 bool isCursorSurface() const;
114
115 bool inhibitsIdle() const;
116 bool isOpaque() const;
117
118#if QT_CONFIG(im)
119 QWaylandInputMethodControl *inputMethodControl() const;
120#endif
121
122public Q_SLOTS:
123#if QT_CONFIG(clipboard)
124 void updateSelection();
125#endif
126
127protected:
128 QWaylandSurface(QWaylandSurfacePrivate &dptr);
129
130Q_SIGNALS:
131 void hasContentChanged();
132 void damaged(const QRegion &rect);
133 void parentChanged(QWaylandSurface *newParent, QWaylandSurface *oldParent);
134 void childAdded(QWaylandSurface *child);
135 Q_REVISION(1, 13) void sourceGeometryChanged();
136 Q_REVISION(1, 13) void destinationSizeChanged();
137 Q_REVISION(1, 13) void bufferSizeChanged();
138 void bufferScaleChanged();
139 void offsetForNextFrame(const QPoint &offset);
140 void contentOrientationChanged();
141 void surfaceDestroyed();
142 void originChanged();
143 void subsurfacePositionChanged(const QPoint &position);
144 void subsurfacePlaceAbove(QWaylandSurface *sibling);
145 void subsurfacePlaceBelow(QWaylandSurface *sibling);
146 void dragStarted(QWaylandDrag *drag);
147 void cursorSurfaceChanged();
148 Q_REVISION(14) void inhibitsIdleChanged();
149 Q_REVISION(6, 4) void isOpaqueChanged();
150
151 void configure(bool hasBuffer);
152 void redraw();
153};
154
155QT_END_NAMESPACE
156
157#endif // QWAYLANDSURFACE_H
QByteArray
\inmodule QtCore
Definition qbytearray.h:57
QList
Definition qlist.h:74
QPointF
\inmodule QtCore\reentrant
Definition qpoint.h:214
QPoint
\inmodule QtCore\reentrant
Definition qpoint.h:23
QRectF
\inmodule QtCore\reentrant
Definition qrect.h:483
QRegion
The QRegion class specifies a clip region for a painter.
Definition qregion.h:27
QSize
\inmodule QtCore
Definition qsize.h:25
QTouchEvent
The QTouchEvent class contains parameters that describe a touch event.
Definition qevent.h:916
QWaylandBufferRef
\inmodule QtWaylandCompositor
Definition qwaylandbufferref.h:28
QWaylandClient
\qmltype WaylandClient \instantiates QWaylandClient \inqmlmodule QtWayland.Compositor
Definition qwaylandclient.h:22
QWaylandCompositor
\qmltype WaylandCompositor \instantiates QWaylandCompositor \inqmlmodule QtWayland....
QWaylandObject
\inmodule QtWaylandCompositor
Definition qwaylandcompositorextension.h:21
QWaylandSurfaceRole
\inmodule QtWaylandCompositor
Definition qwaylandsurface.h:31
QWaylandSurfaceRole::QWaylandSurfaceRole
QWaylandSurfaceRole(const QByteArray &n)
Creates a QWaylandSurfaceRole and assigns it name.
Definition qwaylandsurface.h:33
QWaylandSurfaceRole::name
const QByteArray name()
Returns the name of the QWaylandSurfaceRole.
Definition qwaylandsurface.h:35
QWaylandSurface
\qmltype WaylandSurface \instantiates QWaylandSurface \inqmlmodule QtWayland.Compositor
Definition qwaylandsurface.h:42
QWaylandSurface::parentChanged
void parentChanged(QWaylandSurface *newParent, QWaylandSurface *oldParent)
QWaylandSurface::childAdded
void childAdded(QWaylandSurface *child)
\qmlsignal QtWayland.Compositor::WaylandSurface::childAdded(WaylandSurface child)
QWaylandSurface::hasContentChanged
void hasContentChanged()
QWaylandSurface::Origin
Origin
This enum type is used to specify the origin of a QWaylandSurface's buffer.
Definition qwaylandsurface.h:63
QWaylandSurface::Q_REVISION
Q_REVISION(1, 13) void sourceGeometryChanged()
QWaylandSurface::damaged
void damaged(const QRegion &rect)
QWaylandView
\qmltype WaylandView \instantiates QWaylandView \inqmlmodule QtWayland.Compositor
Definition qwaylandview.h:20
rect
rect
[4]
Definition doc_src_styles.cpp:43
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21
QT_END_NAMESPACE
Definition qsharedpointer.cpp:1545
Qt::ScreenOrientation
ScreenOrientation
Definition qnamespace.h:270
initialize
static bool initialize()
Definition qctf.cpp:67
void
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char return DBusMessage dbus_bool_t return DBusMessage dbus_uint32_t return DBusMessage void
Definition qdbus_symbols_p.h:401
compositor
static QOpenGLCompositor * compositor
Definition qopenglcompositor.cpp:41
offset
GLenum GLuint GLintptr offset
Definition qopengles2ext.h:660
n
GLfloat n
Definition qopengles2ext.h:795
p
GLfloat GLfloat p
[1]
Definition qopenglext.h:12698
QML_UNCREATABLE
#define QML_UNCREATABLE(REASON)
Definition qqmlintegration.h:55
QML_NAMED_ELEMENT
#define QML_NAMED_ELEMENT(NAME)
Definition qqmlintegration.h:52
QML_ADDED_IN_VERSION
#define QML_ADDED_IN_VERSION(MAJOR, MINOR)
Definition qqmlintegration.h:86
position
static qreal position(const QQuickItem *item, QQuickAnchors::Anchor anchorLine)
Definition qquickanchors.cpp:66
Q_ENUM
#define Q_ENUM(x)
Definition qtmetamacros.h:68
Q_PROPERTY
#define Q_PROPERTY(...)
Definition qtmetamacros.h:56
Q_OBJECT
#define Q_OBJECT
Definition qtmetamacros.h:117
Q_REVISION
#define Q_REVISION(...)
Definition qtmetamacros.h:59
Q_INVOKABLE
#define Q_INVOKABLE
Definition qtmetamacros.h:76
Q_SLOTS
#define Q_SLOTS
Definition qtmetamacros.h:44
Q_MOC_INCLUDE
#define Q_MOC_INCLUDE(...)
Definition qtmetamacros.h:79
Q_SIGNALS
#define Q_SIGNALS
Definition qtmetamacros.h:45
uint
unsigned int uint
Definition qtypes.h:29
child
QLayoutItem * child
[0]
Definition src_gui_kernel_qlayout.cpp:25
view
QQuickView * view
[0]
Definition src_plugins_platforms_qnx_qqnxwindow.cpp:5