fix up description and add destroy requests

This commit is contained in:
Vaxry 2023-01-10 14:19:19 +01:00
parent b1984b39fc
commit 62bb2615b7

View file

@ -31,8 +31,8 @@
</copyright> </copyright>
<description summary="registering global shortcuts"> <description summary="registering global shortcuts">
This protocol allows a client to register keystrokes that will be passed This protocol allows a client to register triggerable actions,
to it regardless of its focus state. meant to be global shortcuts.
</description> </description>
<interface name="hyprland_global_shortcuts_manager_v1"> <interface name="hyprland_global_shortcuts_manager_v1">
@ -54,6 +54,13 @@
<arg name="description" type="string" summary="user-readable text describing what the shortcut does."/> <arg name="description" type="string" summary="user-readable text describing what the shortcut does."/>
<arg name="trigger_description" type="string" summary="user-readable text describing how to trigger the shortcut for the client to render."/> <arg name="trigger_description" type="string" summary="user-readable text describing how to trigger the shortcut for the client to render."/>
</request> </request>
<request name="destroy" type="destructor">
<description summary="destroy the manager">
All objects created by the manager will still remain valid, until their
appropriate destroy request has been called.
</description>
</request>
</interface> </interface>
<interface name="hyprland_global_shortcut_v1"> <interface name="hyprland_global_shortcut_v1">
@ -88,5 +95,11 @@
<arg name="tv_nsec" type="uint" <arg name="tv_nsec" type="uint"
summary="nanoseconds part of the timestamp"/> summary="nanoseconds part of the timestamp"/>
</event> </event>
<request name="destroy" type="destructor">
<description summary="delete this object, used or not">
Destroys the shortcut. Can be sent at any time by the client.
</description>
</request>
</interface> </interface>
</protocol> </protocol>