revise against dbus methods

This commit is contained in:
vaxerski 2022-12-21 23:52:36 +00:00
parent ddaab5a69c
commit 8837ff7628
1 changed files with 6 additions and 28 deletions

View File

@ -44,17 +44,15 @@
<description summary="register a shortcut">
Register a new global shortcut.
A keystroke is composed in a format of:
[MOD...+]KEY
A global shortcut is anonymous, meaning the app does not know what key(s) trigger it.
for example:
SUPER+A or ALT+SHIFT+K
A keystroke is not required to have a MOD, although compositors might implement
security measures and reject such keybinds.
The shortcut's keybinding shall be dealt with by the compositor.
</description>
<arg name="shortcut" type="new_id" interface="hyprland_global_shortcut_v1"/>
<arg name="keystroke" type="string" summary="the keystroke"/>
<arg name="id" type="uint" summary="a unique id for the shortcut"/>
<arg name="app_id" type="string" summary="the app_id of the application requesting the shortcut"/>
<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."/>
</request>
</interface>
@ -63,19 +61,6 @@
This object represents a single shortcut.
</description>
<event name="status">
<description summary="keystroke status">
This is the first event sent by the compositor to indicate the status of this
global shortcut.
It will also be fired again shall the status of this shortcut change in the future.
If the status is not "ok", this hyprland_global_shortcut_v1 will not emit any
events other than a possible another status event if the status is changed.
<arg name="status" type="shortcut_status"/>
</description>
</event>
<event name="pressed">
<description summary="keystroke pressed">
The keystroke was pressed.
@ -88,11 +73,4 @@
</description>
</event>
</interface>
<enum name="shortcut_status">
<entry name="ok" value="0" summary="This shortcut has been acknowledged and accepted by the compositor."/>
<entry name="rejected_policy" value="1" summary="The shortcut has been rejected by the compositor due to it violating the compositor's security policy."/>
<entry name="rejected_invalid" value="2" summary="The shortcut has been rejected by the compositor due to an error in parsing the keystroke string."/>
<entry name="rejected_other" value="3" summary="The shortcut has been rejected by the compositor due to an unspecified error."/>
</enum>
</protocol>