QWaylandXdgToplevel Class

The QWaylandXdgToplevel class represents the toplevel window specific parts of an xdg surface. More...

Header:	#include <QWaylandXdgToplevel>
CMake:	find_package(Qt6 COMPONENTS Waylandcompositor REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Waylandcompositor)
qmake:	QT += waylandcompositor
Since:	Qt 5.12
Instantiated By:	XdgToplevel
Inherits:	QObject

• List of all members, including inherited members

Public Types

enum	DecorationMode { ServerSideDecoration, ClientSideDecoration }

Properties

activated : const bool appId : const QString decorationMode : const DecorationMode fullscreen : const bool maxSize : const QSize maximized : const bool

minSize : const QSize parentToplevel : QWaylandXdgToplevel* const resizing : const bool states : const QList<int> title : const QString xdgSurface : QWaylandXdgSurface* const

Public Functions

	QWaylandXdgToplevel(QWaylandXdgSurface *xdgSurface, QWaylandResource &resource)
bool	activated() const
QString	appId() const
QWaylandXdgToplevel::DecorationMode	decorationMode() const
bool	fullscreen() const
QSize	maxSize() const
bool	maximized() const
QSize	minSize() const
QWaylandXdgToplevel *	parentToplevel() const
bool	resizing() const
void	sendClose()
uint	sendConfigure(const QSize &size, const QList<QWaylandXdgToplevel::State> &states)
uint	sendFullscreen(const QSize &size)
uint	sendMaximized(const QSize &size)
uint	sendResizing(const QSize &maxSize)
uint	sendUnmaximized(const QSize &size = QSize(0, 0))
QSize	sizeForResize(const QSizeF &size, const QPointF &delta, Qt::Edges edges) const
QString	title() const
QWaylandXdgSurface *	xdgSurface() const

Signals

void	activatedChanged()
void	appIdChanged()
void	decorationModeChanged()
void	fullscreenChanged()
void	maxSizeChanged()
void	maximizedChanged()
void	minSizeChanged()
void	parentToplevelChanged()
void	resizingChanged()
void	statesChanged()
void	titleChanged()

Static Public Members

QWaylandXdgToplevel *	fromResource(::wl_resource *resource)
QWaylandSurfaceRole *	role()

Detailed Description

This class is part of the QWaylandXdgShell extension and provides a way to extend the functionality of an QWaylandXdgSurface with features specific to desktop-style windows.

It corresponds to the Wayland interface xdg_toplevel.

Member Type Documentation

enum QWaylandXdgToplevel::DecorationMode

This enum type is used to specify the window decoration mode for toplevel windows.

Constant	Value	Description
QWaylandXdgToplevel::ServerSideDecoration	2	The compositor should draw window decorations.
QWaylandXdgToplevel::ClientSideDecoration	1	The client should draw window decorations.

Member Function Documentation

QWaylandXdgToplevel::QWaylandXdgToplevel(QWaylandXdgSurface *xdgSurface, QWaylandResource &resource)

Constructs a QWaylandXdgToplevel for the given xdgSurface and resource.

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

Returns the QWaylandXdgToplevel corresponding to the resource.

[static] QWaylandSurfaceRole *QWaylandXdgToplevel::role()

Returns the surface role for the QWaylandToplevel.

[invokable] void QWaylandXdgToplevel::sendClose()

Sends a close event to the client. The client may choose to ignore the event.

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

uint QWaylandXdgToplevel::sendConfigure(const QSize &size, const QList<QWaylandXdgToplevel::State> &states)

Sends a configure event to the client. Parameter size contains the pixel size of the surface. A size of zero means the client is free to decide the size. Known states are enumerated in QWaylandXdgToplevel::State.

[invokable] uint QWaylandXdgToplevel::sendFullscreen(const QSize &size)

Convenience for sending a configure event with the fullscreen state set, and maximized and resizing removed. The activated state is left in its current state.

size is the new size of the window.

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

See also sendUnmaximized.

[invokable] uint QWaylandXdgToplevel::sendMaximized(const QSize &size)

Convenience for sending a configure event with the maximized state set, and fullscreen and resizing removed. The activated state is left in its current state.

size is the new size of the window.

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

[invokable] uint QWaylandXdgToplevel::sendResizing(const QSize &maxSize)

Convenience for sending a configure event with the resizing state set, and maximized and fullscreen removed. The activated state is left in its current state.

maxSize is the new size of the window.

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

[invokable] uint QWaylandXdgToplevel::sendUnmaximized(const QSize &size = QSize(0, 0))

Convenience for sending a configure event with the maximized, fullscreen and resizing states removed, and fullscreen and resizing removed. The activated state is left in its current state.

size is the new size of the window. If size is zero, the client decides the size.

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

[invokable] QSize QWaylandXdgToplevel::sizeForResize(const QSizeF &size, const QPointF &delta, Qt::Edges edges) const

Convenience for computing the new size given the current size, a delta, and the edges active in the drag.

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