Hyprland global shortcuts
This protocol allows a client to register triggerable actions, meant to be global shortcuts.
hyprland_global_shortcuts_manager_v1
This object is a manager which offers requests to create global shortcuts.
register_shortcut(shortcut: new_id<hyprland_global_shortcut_v1>, id: string, app_id: string, description: string, trigger_description: string)
Argument | Type | Description |
|---|---|---|
| shortcut | new_id<hyprland_global_shortcut_v1> | |
| id | string | a unique id for the shortcut |
| app_id | string | the app_id of the application requesting the shortcut |
| description | string | user-readable text describing what the shortcut does. |
| trigger_description | string | user-readable text describing how to trigger the shortcut for the client to render. |
Register a new global shortcut.
A global shortcut is anonymous, meaning the app does not know what key(s) trigger it.
The shortcut's keybinding shall be dealt with by the compositor.
In the case of a duplicate app_id + id combination, the already_taken protocol error is raised.
destroy()
All objects created by the manager will still remain valid, until their appropriate destroy request has been called.
error { already_taken }
Argument | Value | Description |
|---|---|---|
| already_taken | 0 | the app_id + id combination has already been registered. |
hyprland_global_shortcut_v1
This object represents a single shortcut.
destroy()
Destroys the shortcut. Can be sent at any time by the client.
Argument | Type | Description |
|---|---|---|
| tv_sec_hi | uint | high 32 bits of the seconds part of the timestamp |
| tv_sec_lo | uint | low 32 bits of the seconds part of the timestamp |
| tv_nsec | uint | nanoseconds part of the timestamp |
The keystroke was pressed.
tv_ values hold the timestamp of the occurrence.
Compositor Support
Mutter  47.3 | KWin  6.2 | Sway  1.10 | COSMIC  0.1 | Hyprland  0.42.0 | niri 25.01 | Weston  13 | Mir  2.19 | GameScope  3.15.14 | Jay 1.7.0 | |
|---|---|---|---|---|---|---|---|---|---|---|
| hyprland_global_shortcuts_manager_v1 | x | x | x | x | 1 | x | x | x | x | x |
Copyright
Copyright © 2022 Vaxry All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.