OLD | NEW |
(Empty) | |
| 1 <?xml version="1.0" encoding="UTF-8"?> |
| 2 <protocol name="stylus_tools_unstable_v1"> |
| 3 |
| 4 <copyright> |
| 5 Copyright 2017 The Chromium Authors. |
| 6 |
| 7 Permission is hereby granted, free of charge, to any person obtaining a |
| 8 copy of this software and associated documentation files (the "Software"), |
| 9 to deal in the Software without restriction, including without limitation |
| 10 the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| 11 and/or sell copies of the Software, and to permit persons to whom the |
| 12 Software is furnished to do so, subject to the following conditions: |
| 13 |
| 14 The above copyright notice and this permission notice (including the next |
| 15 paragraph) shall be included in all copies or substantial portions of the |
| 16 Software. |
| 17 |
| 18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 21 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| 23 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| 24 DEALINGS IN THE SOFTWARE. |
| 25 </copyright> |
| 26 |
| 27 <description summary="Protocol for the stylus tools"> |
| 28 This protocol specifies a set of interfaces used to control the behavior |
| 29 of stylus tools. |
| 30 |
| 31 Warning! The protocol described in this file is experimental and backward |
| 32 incompatible changes may be made. Backward compatible changes may be added |
| 33 together with the corresponding interface version bump. Backward |
| 34 incompatible changes are done by bumping the version number in the protocol |
| 35 and interface names and resetting the interface version. Once the protocol |
| 36 is to be declared stable, the 'z' prefix and the version number in the |
| 37 protocol and interface names are removed and the interface version number is |
| 38 reset. |
| 39 </description> |
| 40 |
| 41 <interface name="zcr_stylus_tools_v1" version="1"> |
| 42 <description summary="stylus_tools"> |
| 43 The global interface is used to instantiate an interface extension for a |
| 44 wl_surface object. This extended interface will then allow the client to |
| 45 control the stylus-related behavior for input device event processing |
| 46 related to wl_surface. |
| 47 </description> |
| 48 |
| 49 <request name="destroy" type="destructor"> |
| 50 <description summary="unbind from the stylus_tools interface"> |
| 51 Informs the server that the client will not be using this |
| 52 protocol object anymore. This does not affect any other objects, |
| 53 stylus_tool objects included. |
| 54 </description> |
| 55 </request> |
| 56 |
| 57 <enum name="error"> |
| 58 <entry name="stylus_tool_exists" value="0" |
| 59 summary="the surface already has a stylus_tool object associated"/> |
| 60 </enum> |
| 61 |
| 62 <request name="get_stylus_tool"> |
| 63 <description summary="extend surface interface for stylus_tool"> |
| 64 Instantiate an interface extension for the given wl_surface to |
| 65 provide access to the stylus tools features. If the given |
| 66 wl_surface already has an stylus_tool object associated, |
| 67 the stylus_tool_exists protocol protocol error is raised. |
| 68 </description> |
| 69 |
| 70 <arg name="id" type="new_id" interface="zcr_stylus_tool_v1" |
| 71 summary="the new stylus_tool interface id"/> |
| 72 <arg name="surface" type="object" interface="wl_surface" |
| 73 summary="the surface"/> |
| 74 </request> |
| 75 </interface> |
| 76 |
| 77 <interface name="zcr_stylus_tool_v1" version="1"> |
| 78 <description summary="stylus_tool interface to a wl_surface"> |
| 79 An additional interface to a wl_surface object, which allows the |
| 80 client to control the behavior of stylus tools. |
| 81 |
| 82 If the wl_surface associated with the stylus_tool object is destroyed, |
| 83 the stylus_tool object becomes inert. |
| 84 |
| 85 If the stylus_tool object is destroyed, the stylus_tool state is removed |
| 86 from the wl_surface. The change will be applied on the next |
| 87 wl_surface.commit. |
| 88 </description> |
| 89 |
| 90 <request name="destroy" type="destructor"> |
| 91 <description summary="remove stylus_tool from the surface"> |
| 92 The associated wl_surface's stylus_tool state is removed. |
| 93 The change is applied on the next wl_surface.commit. |
| 94 </description> |
| 95 </request> |
| 96 |
| 97 <request name="set_stylus_only"> |
| 98 <description summary="Set the stylus-only mode"> |
| 99 Enables the "stylus-only" mode for input device event processing |
| 100 related to wl_surface. |
| 101 </description> |
| 102 </request> |
| 103 </interface> |
| 104 |
| 105 </protocol> |
OLD | NEW |