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: |
Properties
- active : bool
- protocolVersion : int
Public Functions
| QWaylandClientExtension(const int ver) | |
| virtual | ~QWaylandClientExtension() |
| bool | isActive() const |
| int | version() const |
Signals
| void | activeChanged() |
| void | versionChanged() |
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 of the protocol that has been requested.
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.