shortcut manager

This interface allows a client to get some shell's info.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

register_shortcut_context(key: string, id: new_id<treeland_shortcut_context_v1>)
Argument
Type
Description
keystring
idnew_id<treeland_shortcut_context_v1>
register shortcut key

The format of the shortcut key is 'Modify+Key', such as 'Ctrl+Alt+T'. If the format is wrong, the synthesizer will give a "format error". If the shortcut key is already registered, the compositor will give a "register error" and issue a destruction to the context.


client shortcut context

This interface allows a client to listen a shortcut action.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

destroy()
destroy the context object

Destroy the context object.

error { register_failed } 
Argument
Value
Description
register_failed1
shortcut register failed

Compositor Support

Mutter
Mutter
47.3
KWin
KWin
6.3
Sway
Sway
1.10
COSMIC
COSMIC
0.1
Hyprland
Hyprland
0.44
niri
25.01
Weston
Weston
14
Mir
Mir
2.19
GameScope
GameScope
3.15.14
Jay
1.9.0
Labwc
Labwc
0.8.2
Wayfire
0.9.0
Treeland
Treeland
0.5.17
Louvre
Louvre
2.14.1
treeland_shortcut_manager_v1
x
x
x
x
x
x
x
x
x
x
x
x
1
x

SPDX-FileCopyrightText: 2024 UnionTech Software Technology Co., Ltd. SPDX-License-Identifier: MIT