protocols/wlr-input-inhibitor-unstable-v1.xml
author agaric <agaric@protonmail.com>
Tue, 09 Mar 2021 07:18:07 +0000
changeset 0 5f04caa7212d
permissions -rw-r--r--
git import
0
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     1
<?xml version="1.0" encoding="UTF-8"?>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     2
<protocol name="wlr_input_inhibit_unstable_v1">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     3
  <copyright>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     4
    Copyright © 2018 Drew DeVault
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     5
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     6
    Permission to use, copy, modify, distribute, and sell this
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     7
    software and its documentation for any purpose is hereby granted
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     8
    without fee, provided that the above copyright notice appear in
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     9
    all copies and that both that copyright notice and this permission
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    10
    notice appear in supporting documentation, and that the name of
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    11
    the copyright holders not be used in advertising or publicity
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    12
    pertaining to distribution of the software without specific,
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    13
    written prior permission.  The copyright holders make no
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    14
    representations about the suitability of this software for any
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    15
    purpose.  It is provided "as is" without express or implied
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    16
    warranty.
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    17
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    18
    THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    19
    SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    20
    FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    21
    SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    22
    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    23
    AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    24
    ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    25
    THIS SOFTWARE.
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    26
  </copyright>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    27
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    28
  <interface name="zwlr_input_inhibit_manager_v1" version="1">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    29
    <description summary="inhibits input events to other clients">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    30
      Clients can use this interface to prevent input events from being sent to
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    31
      any surfaces but its own, which is useful for example in lock screen
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    32
      software. It is assumed that access to this interface will be locked down
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    33
      to whitelisted clients by the compositor.
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    34
    </description>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    35
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    36
    <request name="get_inhibitor">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    37
      <description summary="inhibit input to other clients">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    38
        Activates the input inhibitor. As long as the inhibitor is active, the
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    39
        compositor will not send input events to other clients.
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    40
      </description>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    41
      <arg name="id" type="new_id" interface="zwlr_input_inhibitor_v1"/>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    42
    </request>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    43
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    44
    <enum name="error">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    45
      <entry name="already_inhibited" value="0" summary="an input inhibitor is already in use on the compositor"/>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    46
    </enum>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    47
  </interface>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    48
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    49
  <interface name="zwlr_input_inhibitor_v1" version="1">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    50
    <description summary="inhibits input to other clients">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    51
      While this resource exists, input to clients other than the owner of the
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    52
      inhibitor resource will not receive input events. The client that owns
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    53
      this resource will receive all input events normally. The compositor will
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    54
      also disable all of its own input processing (such as keyboard shortcuts)
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    55
      while the inhibitor is active.
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    56
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    57
      The compositor may continue to send input events to selected clients,
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    58
      such as an on-screen keyboard (via the input-method protocol).
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    59
    </description>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    60
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    61
    <request name="destroy" type="destructor">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    62
      <description summary="destroy the input inhibitor object">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    63
        Destroy the inhibitor and allow other clients to receive input.
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    64
      </description>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    65
    </request>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    66
  </interface>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    67
</protocol>