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