[PATCH 2/2] Add keyboard shortcuts inhibitor

[Peter Hutterer]

On Wed, Mar 22, 2017 at 05:27:23PM +0100, Olivier Fourdan wrote:
> This adds a new protocol to let Wayland clients specify that they want
> all keyboard events to be send to the client, regardless of the
> compositor own shortcuts.
> 
> This is for use by virtual machine and remote connections viewers.

I think it should have a blurb to state that it's still the compositor that
decides whether any given shortcut is inhibited, but otherwise this looks
good, thanks.

Cheers,
   Peter

> 
> Signed-off-by: Olivier Fourdan <ofourdan at redhat.com>
> ---
>  unstable/keyboard-shortcuts-inhibit/README         |  4 +
>  .../keyboard-shortcuts-inhibit-unstable-v1.xml     | 85 ++++++++++++++++++++++
>  2 files changed, 89 insertions(+)
>  create mode 100644 unstable/keyboard-shortcuts-inhibit/README
>  create mode 100644 unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml
> 
> diff --git a/unstable/keyboard-shortcuts-inhibit/README b/unstable/keyboard-shortcuts-inhibit/README
> new file mode 100644
> index 0000000..929959c
> --- /dev/null
> +++ b/unstable/keyboard-shortcuts-inhibit/README
> @@ -0,0 +1,4 @@
> +Compositor shortcut inhibit protocol
> +
> +Maintainers:
> +Olivier Fourdan <ofourdan at redhat.com>
> diff --git a/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml b/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml
> new file mode 100644
> index 0000000..f68e25a
> --- /dev/null
> +++ b/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml
> @@ -0,0 +1,85 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<protocol name="keyboard_shortcuts_inhibit_unstable_v1">
> +
> +  <copyright>
> +	Copyright © 2017 Red Hat Inc.
> +
> +	Permission is hereby granted, free of charge, to any person obtaining a
> +	copy of this software and associated documentation files (the "Software"),
> +	to deal in the Software without restriction, including without limitation
> +	the rights to use, copy, modify, merge, publish, distribute, sublicense,
> +	and/or sell copies of the Software, and to permit persons to whom the
> +	Software is furnished to do so, subject to the following conditions:
> +
> +	The above copyright notice and this permission notice (including the next
> +	paragraph) shall be included in all copies or substantial portions of the
> +	Software.
> +
> +	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> +	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> +	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
> +	THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> +	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> +	FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
> +	DEALINGS IN THE SOFTWARE.
> +  </copyright>
> +
> +  <description summary="Protocol for inhibitting the compositor keyboard shortcuts">
> +	This protocol specifies a way for a client to request the compositor
> +	to ignore its own keyboard shortcuts, so that all keyboard events
> +	get forwarded to a surface.
> +
> +	Warning! The protocol described in this file is experimental and
> +	backward incompatible changes may be made. Backward compatible
> +	changes may be added together with the corresponding interface
> +	version bump.
> +	Backward incompatible changes are done by bumping the version
> +	number in the protocol and interface names and resetting the
> +	interface version. Once the protocol is to be declared stable,
> +	the 'z' prefix and the version number in the protocol and
> +	interface names are removed and the interface version number is
> +	reset.
> +  </description>
> +
> +  <interface name="zwp_keyboard_shortcuts_inhibit_manager_v1" version="1">
> +
> +    <request name="destroy" type="destructor">
> +      <description summary="destroy the keyboard shortcuts inhibitor object">
> +	Destroy the keyboard shortcuts inhibitor manager.
> +      </description>
> +    </request>
> +
> +    <request name="inhibit_shortcuts">
> +      <description summary="create a new keyboard shortcuts inhibitor object">
> +	Create a new keyboard shortcuts inhibitor object associated with the given surface.
> +      </description>
> +      <arg name="id" type="new_id" interface="zwp_keyboard_shortcuts_inhibitor_v1"/>
> +      <arg name="surface" type="object" interface="wl_surface"
> +	   summary="the surface that inhibits the keyboard shortcuts behavior"/>
> +    </request>
> +
> +  </interface>
> +
> +  <interface name="zwp_keyboard_shortcuts_inhibitor_v1" version="1">
> +    <description summary="context object for keyboard shortcuts inhibitor">
> +	A keyboard shortcuts inhibitor instructs the compositor to ignore
> +	its own keyboard shortcuts when the associated surface has keyboard
> +	focus. As a result, when the surface is focused, it will receive all
> +	keyboard events, even those which would normally be caught by the
> +	compositor for its own shortcuts.
> +
> +	If the surface is destroyed, unmapped, or loses keyboard focus, the
> +	the compositor will restore its own keyboard shortcuts.
> +
> +	If the surface regains keyboard focus the inhibitor will take effect
> +	again.
> +    </description>
> +
> +    <request name="destroy" type="destructor">
> +      <description summary="destroy the keyboard shortcuts inhibitor object">
> +	Remove the keyboard shortcuts inhibitor from the associated wl_surface.
> +      </description>
> +    </request>
> +
> +  </interface>
> +</protocol>
> -- 
> 2.9.3
> 

> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/wayland-devel