On this page
QWaylandWlShell Class
The QWaylandWlShell class is an extension for desktop-style user interfaces. More...
Header: | #include <QWaylandWlShell> |
qmake: | QT += waylandcompositor |
Since: | Qt 5.8 |
Inherits: | QWaylandShellTemplate |
Public Functions
QWaylandWlShell() | |
QWaylandWlShell(QWaylandCompositor *compositor) | |
QList<QWaylandWlShellSurface *> | mappedPopups() const |
QWaylandClient * | popupClient() const |
QList<QWaylandWlShellSurface *> | shellSurfaces() const |
QList<QWaylandWlShellSurface *> | shellSurfacesForClient(QWaylandClient *client) const |
Reimplemented Public Functions
virtual void | initialize() override |
- 2 public functions inherited from QWaylandShell
- 4 public functions inherited from QWaylandCompositorExtension
- 5 public functions inherited from QWaylandObject
- 32 public functions inherited from QObject
Public Slots
void | closeAllPopups() |
- 1 public slot inherited from QObject
Signals
void | wlShellSurfaceCreated(QWaylandWlShellSurface *shellSurface) |
void | wlShellSurfaceRequested(QWaylandSurface *surface, const QWaylandResource &resource) |
- 1 signal inherited from QWaylandShell
- 2 signals inherited from QObject
Additional Inherited Members
- 1 property inherited from QWaylandShell
- 1 property inherited from QObject
- 11 static public members inherited from QObject
- 1 protected function inherited from QWaylandCompositorExtension
- 9 protected functions inherited from QObject
Detailed Description
The QWaylandWlShell class is an extension for desktop-style user interfaces.
The QWaylandWlShell extension provides a way to associate a QWaylandWlShellSurface with a regular Wayland surface. Using the shell surface interface, the client can request that the surface is resized, moved, and so on.
WlShell corresponds to the Wayland interface wl_shell
.
Member Function Documentation
QWaylandWlShell::QWaylandWlShell()
Constructs a QWaylandWlShell object.
QWaylandWlShell::QWaylandWlShell(QWaylandCompositor *compositor)
Constructs a QWaylandWlShell object for the provided compositor.
[slot]
void QWaylandWlShell::closeAllPopups()
[override virtual]
void QWaylandWlShell::initialize()
Initializes the WlShell extension.
QList<QWaylandWlShellSurface *> QWaylandWlShell::mappedPopups() const
QWaylandClient *QWaylandWlShell::popupClient() const
QList<QWaylandWlShellSurface *> QWaylandWlShell::shellSurfaces() const
QList<QWaylandWlShellSurface *> QWaylandWlShell::shellSurfacesForClient(QWaylandClient *client) const
[signal]
void QWaylandWlShell::wlShellSurfaceCreated(QWaylandWlShellSurface *shellSurface)
This signal is emitted when the client has created a wl_shell_surface
. A common use case is to let the handler of this signal instantiate a QWaylandShellSurfaceItem or QWaylandQuickItem for displaying shellSurface in a QtQuick scene.
[signal]
void QWaylandWlShell::wlShellSurfaceRequested(QWaylandSurface *surface, const QWaylandResource &resource)
This signal is emitted when the client has requested a wl_shell_surface
to be associated with surface. The handler for this signal may create a shell surface for resource and initialize it within the scope of the signal emission. Otherwise a QWaylandWlShellSurface will be created automatically.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qwaylandwlshell.html