On this page

QWaylandClientExtension Class

A class for implementing custom extensions on the Wayland protocol. More...

Header: #include <QWaylandClientExtension>
CMake: find_package(Qt6 REQUIRED COMPONENTS WaylandClient)
target_link_libraries(mytarget PRIVATE Qt6::WaylandClient)
qmake: QT += waylandclient
Inherits: QObject
Inherited By:

QWaylandClientExtensionTemplate

Properties

Public Functions

QWaylandClientExtension(const int ver)
virtual ~QWaylandClientExtension()
bool isActive() const
int version() const

Signals

Detailed Description

The QWaylandClientExtension class can be used to implement custom extensions for Wayland protocol. The extension must also be supported by the compositor in order to be usable. See the Custom Extension example in Qt Wayland Compositor for an example that implements both the compositor and client sides of a custom extension.

This class is usually not inherited directly, but through QWaylandClientExtensionTemplate for convenience.

Property Documentation

[read-only] active : bool

This property holds the active state of the extension.

Set to true if the extension is currently active. Otherwise this property is false.

Access functions:

bool isActive() const

Notifier signal:

void activeChanged()

[read-only] protocolVersion : int

This property holds the version of the protocol.

This property holds the version the protocol has been registered under.

Access functions:

int version() const

Notifier signal:

void versionChanged()

Member Function Documentation

QWaylandClientExtension::QWaylandClientExtension(const int ver)

Constructs the client extension and sets its version to ver.

[virtual noexcept] QWaylandClientExtension::~QWaylandClientExtension()

Destroys the client extension.

© 2026 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.