Back to Qt.io
Contact Us Blog Download Qt

XdgSurfaceV5 QML Type

Provides a xdg_surface that offers desktop-style compositor-specific features to a surface. More...

Import Statement: import QtWayland.Compositor 1.15
Since: Qt 5.8

Properties

Signals

Methods

Detailed Description

This type is part of the XdgShellV5 extension and provides a way to extend the functionality of an existing WaylandSurface with features specific to desktop-style compositors, such as resizing and moving the surface.

It corresponds to the Wayland interface xdg_surface for the unstable xdg-shell protocol v5.

Property Documentation

parentSurface : XdgSurfaceV5

This property holds the XdgSurfaceV5 parent of this XdgSurfaceV5. When a parent surface is set, the parentSurfaceChanged() signal is guaranteed to be emitted before setTopLevel() and setTransient().

See also QtWaylandCompositor::XdgSurfaceV5::setTopLevel() and QtWaylandCompositor::XdgSurfaceV5::setTransient().


shell : XdgShellV5

This property holds the shell associated with this XdgSurfaceV5.


surface : WaylandSurface

This property holds the surface associated with this XdgSurfaceV5.


title : string

This property holds the title of the XdgSurfaceV5.


windowType : enumeration

This property holds the window type of the XdgSurfaceV5.


Signal Documentation

void ackConfigure(int serial)

This signal is emitted when the client has received configure events up to and including the configure event with serial serial and will draw its surface accordingly in the next committed buffer.

Note: The corresponding handler is onAckConfigure.


void setFullscreen(WaylandOutput output)

This signal is emitted when the client wants the xdg_surface to be in full screen mode. The client may specify an output it wishes the xdg_surface to be shown on.

Note: The corresponding handler is onSetFullscreen.


void setMaximized()

This signal is emitted when the client wants the xdg_surface to be maximized.

Note: The corresponding handler is onSetMaximized.


void setMinimized()

This signal is emitted when the client wants the xdg_surface to be minimized.

Note: The corresponding handler is onSetMinimized.


setTopLevel()

This signal is emitted when the parent surface is unset, effectively making the window top level.

Note: The corresponding handler is onSetTopLevel.


setTransient()

This signal is emitted when the parent surface is set, effectively making the window transient.

Note: The corresponding handler is onSetTransient.


void showWindowMenu(WaylandSeat seat, point localSurfacePosition)

This signal is emitted when the client wants to show a context menu at localSurfacePosition, using the Wayland seat seat. It's typically emitted in response to the user right-clicking the window decorations.

Note: The corresponding handler is onShowWindowMenu.


void startMove(WaylandSeat seat)

This signal is emitted when the client wants to start an interactive move of the XdgSurfaceV5, typically in response to the window decorations being dragged by seat.

Note: The corresponding handler is onStartMove.


void startResize(WaylandSeat seat, enumeration edges)

This signal is emitted when the client wants to start an interactive resize of the XdgSurfaceV5, typically in response to the window decorations being dragged by seat on the window borders given by edges.

Note: The corresponding handler is onStartResize.

See also QWaylandXdgSurfaceV5::ResizeEdge.


void unsetFullscreen()

This signal is emitted when the client doesn't want the xdg_surface to be in full screen mode anymore.

Note: The corresponding handler is onUnsetFullscreen.


void unsetMaximized()

This signal is emitted when the client doesn't want the xdg_surface to be maximized anymore.

Note: The corresponding handler is onUnsetMaximized.


Method Documentation

void initialize(XdgShellV5 xdgShell, WaylandSurface surface, WaylandResource resource)

Initializes the XdgSurfaceV5, associating it with the given xdgShell, surface, and resource.


void sendClose()

Sends a close event to the client.


int sendConfigure(size size, list<uint> states)

Sends a configure event to the client. size contains the pixel size of the surface. Known states are enumerated in XdgSurfaceV5::State.


© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.