QWaylandWlShellSurface Class

The QWaylandWlShellSurface class provides desktop-style compositor-specific features to a surface. More...

Header:	#include <QWaylandWlShellSurface>
CMake:	find_package(Qt6 COMPONENTS Waylandcompositor REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Waylandcompositor)
qmake:	QT += waylandcompositor
Since:	Qt 5.8
Instantiated By:	WlShellSurface
Inherits:	QWaylandShellSurfaceTemplate

• List of all members, including inherited members

Public Types

enum	ResizeEdge { NoneEdge, TopEdge, BottomEdge, LeftEdge, TopLeftEdge, …, BottomRightEdge }

Properties

• className : const QString
• shell : QWaylandWlShell* const
• surface : QWaylandSurface* const
• title : const QString

Public Functions

	QWaylandWlShellSurface(QWaylandWlShell *shell, QWaylandSurface *surface, const QWaylandResource &res)
	QWaylandWlShellSurface()
QString	className() const
void	initialize(QWaylandWlShell *shell, QWaylandSurface *surface, const QWaylandResource &resource)
void	sendConfigure(const QSize &size, QWaylandWlShellSurface::ResizeEdge edges)
void	sendPopupDone()
QWaylandWlShell *	shell() const
QWaylandSurface *	surface() const
QString	title() const

Public Slots

void

ping()

Signals

void	classNameChanged()
void	shellChanged()
void	surfaceChanged()
void	titleChanged()

Static Public Members

QWaylandWlShellSurface *

fromResource(wl_resource *resource)

Detailed Description

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

It corresponds to the Wayland interface wl_shell_surface.

Member Type Documentation

enum QWaylandWlShellSurface::ResizeEdge

This enum type provides a way to specify an edge or corner of the surface.

Constant	Value	Description
QWaylandWlShellSurface::NoneEdge	0	No edge.
QWaylandWlShellSurface::TopEdge	1	The top edge.
QWaylandWlShellSurface::BottomEdge	2	The bottom edge.
QWaylandWlShellSurface::LeftEdge	4	The left edge.
QWaylandWlShellSurface::TopLeftEdge	5	The top left corner.
QWaylandWlShellSurface::BottomLeftEdge	6	The bottom left corner.
QWaylandWlShellSurface::RightEdge	8	The right edge.
QWaylandWlShellSurface::TopRightEdge	9	The top right corner.
QWaylandWlShellSurface::BottomRightEdge	10	The bottom right corner.

Member Function Documentation

QWaylandWlShellSurface::QWaylandWlShellSurface(QWaylandWlShell *shell, QWaylandSurface *surface, const QWaylandResource &res)

Constructs a QWaylandWlShellSurface for surface and initializes it with the given shell and resource res.

QWaylandWlShellSurface::QWaylandWlShellSurface()

Constructs a QWaylandWlShellSurface.

[slot] void QWaylandWlShellSurface::ping()

Sends a ping event to the client. If the client replies to the event the pong signal will be emitted.

[static] QWaylandWlShellSurface *QWaylandWlShellSurface::fromResource(wl_resource *resource)

Returns the QWaylandWlShellSurface object associated with the given resource, or null if no such object exists.

[invokable] void QWaylandWlShellSurface::initialize(QWaylandWlShell *shell, QWaylandSurface *surface, const QWaylandResource &resource)

Initializes the QWaylandWlShellSurface and associates it with the given shell, surface, and resource.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[invokable] void QWaylandWlShellSurface::sendConfigure(const QSize &size, QWaylandWlShellSurface::ResizeEdge edges)

Sends a configure event to the client, suggesting that it resize its surface to the provided size. The edges provide a hint about how the surface was resized.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[invokable] void QWaylandWlShellSurface::sendPopupDone()

Sends a popup_done event to the client to indicate that the user has clicked somewhere outside the client's surfaces.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.