🛠️🐜 Antkeeper superbuild with dependencies included https://antkeeper.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

143 lines
6.5 KiB

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <protocol name="keyboard_shortcuts_inhibit_unstable_v1">
  3. <copyright>
  4. Copyright © 2017 Red Hat Inc.
  5. Permission is hereby granted, free of charge, to any person obtaining a
  6. copy of this software and associated documentation files (the "Software"),
  7. to deal in the Software without restriction, including without limitation
  8. the rights to use, copy, modify, merge, publish, distribute, sublicense,
  9. and/or sell copies of the Software, and to permit persons to whom the
  10. Software is furnished to do so, subject to the following conditions:
  11. The above copyright notice and this permission notice (including the next
  12. paragraph) shall be included in all copies or substantial portions of the
  13. Software.
  14. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  17. THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19. FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20. DEALINGS IN THE SOFTWARE.
  21. </copyright>
  22. <description summary="Protocol for inhibiting the compositor keyboard shortcuts">
  23. This protocol specifies a way for a client to request the compositor
  24. to ignore its own keyboard shortcuts for a given seat, so that all
  25. key events from that seat get forwarded to a surface.
  26. Warning! The protocol described in this file is experimental and
  27. backward incompatible changes may be made. Backward compatible
  28. changes may be added together with the corresponding interface
  29. version bump.
  30. Backward incompatible changes are done by bumping the version
  31. number in the protocol and interface names and resetting the
  32. interface version. Once the protocol is to be declared stable,
  33. the 'z' prefix and the version number in the protocol and
  34. interface names are removed and the interface version number is
  35. reset.
  36. </description>
  37. <interface name="zwp_keyboard_shortcuts_inhibit_manager_v1" version="1">
  38. <description summary="context object for keyboard grab_manager">
  39. A global interface used for inhibiting the compositor keyboard shortcuts.
  40. </description>
  41. <request name="destroy" type="destructor">
  42. <description summary="destroy the keyboard shortcuts inhibitor object">
  43. Destroy the keyboard shortcuts inhibitor manager.
  44. </description>
  45. </request>
  46. <request name="inhibit_shortcuts">
  47. <description summary="create a new keyboard shortcuts inhibitor object">
  48. Create a new keyboard shortcuts inhibitor object associated with
  49. the given surface for the given seat.
  50. If shortcuts are already inhibited for the specified seat and surface,
  51. a protocol error "already_inhibited" is raised by the compositor.
  52. </description>
  53. <arg name="id" type="new_id" interface="zwp_keyboard_shortcuts_inhibitor_v1"/>
  54. <arg name="surface" type="object" interface="wl_surface"
  55. summary="the surface that inhibits the keyboard shortcuts behavior"/>
  56. <arg name="seat" type="object" interface="wl_seat"
  57. summary="the wl_seat for which keyboard shortcuts should be disabled"/>
  58. </request>
  59. <enum name="error">
  60. <entry name="already_inhibited"
  61. value="0"
  62. summary="the shortcuts are already inhibited for this surface"/>
  63. </enum>
  64. </interface>
  65. <interface name="zwp_keyboard_shortcuts_inhibitor_v1" version="1">
  66. <description summary="context object for keyboard shortcuts inhibitor">
  67. A keyboard shortcuts inhibitor instructs the compositor to ignore
  68. its own keyboard shortcuts when the associated surface has keyboard
  69. focus. As a result, when the surface has keyboard focus on the given
  70. seat, it will receive all key events originating from the specified
  71. seat, even those which would normally be caught by the compositor for
  72. its own shortcuts.
  73. The Wayland compositor is however under no obligation to disable
  74. all of its shortcuts, and may keep some special key combo for its own
  75. use, including but not limited to one allowing the user to forcibly
  76. restore normal keyboard events routing in the case of an unwilling
  77. client. The compositor may also use the same key combo to reactivate
  78. an existing shortcut inhibitor that was previously deactivated on
  79. user request.
  80. When the compositor restores its own keyboard shortcuts, an
  81. "inactive" event is emitted to notify the client that the keyboard
  82. shortcuts inhibitor is not effectively active for the surface and
  83. seat any more, and the client should not expect to receive all
  84. keyboard events.
  85. When the keyboard shortcuts inhibitor is inactive, the client has
  86. no way to forcibly reactivate the keyboard shortcuts inhibitor.
  87. The user can chose to re-enable a previously deactivated keyboard
  88. shortcuts inhibitor using any mechanism the compositor may offer,
  89. in which case the compositor will send an "active" event to notify
  90. the client.
  91. If the surface is destroyed, unmapped, or loses the seat's keyboard
  92. focus, the keyboard shortcuts inhibitor becomes irrelevant and the
  93. compositor will restore its own keyboard shortcuts but no "inactive"
  94. event is emitted in this case.
  95. </description>
  96. <request name="destroy" type="destructor">
  97. <description summary="destroy the keyboard shortcuts inhibitor object">
  98. Remove the keyboard shortcuts inhibitor from the associated wl_surface.
  99. </description>
  100. </request>
  101. <event name="active">
  102. <description summary="shortcuts are inhibited">
  103. This event indicates that the shortcut inhibitor is active.
  104. The compositor sends this event every time compositor shortcuts
  105. are inhibited on behalf of the surface. When active, the client
  106. may receive input events normally reserved by the compositor
  107. (see zwp_keyboard_shortcuts_inhibitor_v1).
  108. This occurs typically when the initial request "inhibit_shortcuts"
  109. first becomes active or when the user instructs the compositor to
  110. re-enable and existing shortcuts inhibitor using any mechanism
  111. offered by the compositor.
  112. </description>
  113. </event>
  114. <event name="inactive">
  115. <description summary="shortcuts are restored">
  116. This event indicates that the shortcuts inhibitor is inactive,
  117. normal shortcuts processing is restored by the compositor.
  118. </description>
  119. </event>
  120. </interface>
  121. </protocol>