Skip to content

hyprland_global_shortcuts_manager_v1¤

wayland.hyprland_global_shortcuts_manager_v1 ¤

Manager to register global shortcuts

This object is a manager which offers requests to create global shortcuts.

Methods:

error ¤

  • already_taken –
    The `app_id` + id combination has already been registered.

register_shortcut ¤

register_shortcut(
    id: str, app_id: str, description: str, trigger_description: str
) -> hyprland_global_shortcut_v1

Register a shortcut

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.

Parameters:

  • id ¤

    (str) –

    A unique id for the shortcut

  • app_id ¤

    (str) –

    The app_id of the application requesting the shortcut

  • description ¤

    (str) –

    User-readable text describing what the shortcut does.

  • trigger_description ¤

    (str) –

    User-readable text describing how to trigger the shortcut for the client to render.

Returns:

destroy ¤

destroy() -> None

Destroy the manager

All objects created by the manager will still remain valid, until their appropriate destroy request has been called.