KWaylandExtras Class
A collection of functions to do Wayland things. More...
| Header: | #include <KWaylandExtras> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS KWindowSystem)target_link_libraries(mytarget PRIVATE KF6::KWindowSystem) |
| Since: | 6.0 |
Signals
(since 6.0) void | windowExported(QWindow *window, const QString &handle) |
Static Public Members
(since 6.0) void | exportWindow(QWindow *window) |
| quint32 | lastInputSerial(QWindow *window) |
| KWaylandExtras * | self() |
(since 6.22) void | setXdgToplevelDescription(QWindow *window, const QString &description) |
(since 6.22) void | setXdgToplevelTag(QWindow *window, const QString &tag) |
(since 6.0) void | unexportWindow(QWindow *window) |
(since 6.19) QFuture<QString> | xdgActivationToken(QWindow *window, const QString &appId) |
(since 6.19) QFuture<QString> | xdgActivationToken(QWindow *window, uint32_t serial, const QString &appId) |
Detailed Description
Member Function Documentation
[static invokable, since 6.0] void KWaylandExtras::exportWindow(QWindow *window)
Requests to export the given window using xdg_foreign_v2.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
This function was introduced in 6.0.
See also windowExported.
[static invokable] quint32 KWaylandExtras::lastInputSerial(QWindow *window)
Offers the seat's current serial for the given window.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[static] KWaylandExtras *KWaylandExtras::self()
[static, since 6.22] void KWaylandExtras::setXdgToplevelDescription(QWindow *window, const QString &description)
Assigns the specified description to the given window.
This function was introduced in 6.22.
[static, since 6.22] void KWaylandExtras::setXdgToplevelTag(QWindow *window, const QString &tag)
Assigns the specified tag to the given window.
This function was introduced in 6.22.
[static invokable, since 6.0] void KWaylandExtras::unexportWindow(QWindow *window)
Unexports the window previously exported using xdg_foreign_v2.
Asks the compositor to revoke the handle.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
This function was introduced in 6.0.
[signal, since 6.0] void KWaylandExtras::windowExported(QWindow *window, const QString &handle)
The handle of the given window to pass to the client.
This function was introduced in 6.0.
See also exportWindow.
[static, since 6.19] QFuture<QString> KWaylandExtras::xdgActivationToken(QWindow *window, const QString &appId)
Requests an xdg_activation_v1 token for a specific window window with the given appId. The last received input serial will be used to request the token.
The appId may be empty, in which case any application can use the token. This should usually be avoided!
Note: No xdgActivationTokenArrived() signal will be emitted for this token. Use the QFuture instead.
This function was introduced in 6.19.
[static, since 6.19] QFuture<QString> KWaylandExtras::xdgActivationToken(QWindow *window, uint32_t serial, const QString &appId)
Requests an xdg_activation_v1 token for a specific window window with the given appId. The serial indicates an event that triggered the request.
The appId may be empty, in which case any application can use the token. This should usually be avoided!
Note: No xdgActivationTokenArrived() signal will be emitted for this token. Use the QFuture instead.
This function was introduced in 6.19.