OLD | NEW |
---|---|
(Empty) | |
1 <?xml version="1.0" encoding="UTF-8"?> | |
2 <protocol name="annotation_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 limitatio n | |
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 nex t | |
15 paragraph) shall be included in all copies or substantial portions of th e | |
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 OTH ER | |
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 annotation layer"> | |
28 This protocol specifies a set of interfaces to control the behavior | |
29 or the annotation layer, a special layer allowing the user to annotate | |
30 the on-screen content. | |
31 | |
32 Warning! The protocol described in this file is experimental and backwar d | |
33 incompatible changes may be made. Backward compatible changes may be add ed | |
34 together with the corresponding interface version bump. Backward | |
35 incompatible changes are done by bumping the version number in the proto col | |
36 and interface names and resetting the interface version. Once the protoc ol | |
37 is to be declared stable, the 'z' prefix and the version number in the | |
38 protocol and interface names are removed and the interface version numbe r is | |
39 reset. | |
40 </description> | |
41 | |
42 <interface name="zcr_annotation_v1" version="1"> | |
43 <description summary="annotation"> | |
44 The global interface exposing the annotation layer capabilities is | |
45 used to instantiate an interface extension for a wl_surface object. | |
46 This extended interface will then allow the client to specify the | |
47 features of the annotation layer. | |
48 </description> | |
49 | |
50 <request name="destroy" type="destructor"> | |
51 <description summary="unbind from the annotation interface"> | |
52 Informs the server that the client will not be using this | |
53 protocol object anymore. This does not affect any other objects, | |
54 annotation_features objects included. | |
55 </description> | |
56 </request> | |
57 | |
58 <enum name="error"> | |
59 <entry name="annotation_features_exists" value="0" | |
60 summary="the surface already has an annotation_features objec t associated"/> | |
61 </enum> | |
62 | |
63 <request name="get_annotation_features"> | |
64 <description summary="extend surface interface for annotation_featur es"> | |
65 Instantiate an interface extension for the given wl_surface to | |
66 provide access to the annotation layer features. If the given wl _surface | |
67 already has an annotation_features object associated, the | |
68 annotation_features_exists protocol error is raised. | |
69 </description> | |
70 | |
71 <arg name="id" type="new_id" interface="zcr_annotation_features_v1" | |
72 summary="the new annotation_features interface id"/> | |
73 <arg name="surface" type="object" interface="wl_surface" | |
74 summary="the surface"/> | |
75 </request> | |
76 </interface> | |
77 | |
78 <interface name="zcr_annotation_features_v1" version="1"> | |
reveman
2017/05/23 16:41:06
nit: please name this interface based on the funct
Vladislav Kaznacheev
2017/05/23 23:48:56
Done.
| |
79 <description summary="annotation_features interface to a wl_surface"> | |
80 An additional interface to a wl_surface object, which allows the | |
81 client to specify the features of the annotation layer. | |
82 | |
83 If the wl_surface associated with the annotation_features object is destroyed, | |
reveman
2017/05/23 16:41:06
nit: please break this line in a way that's consis
Vladislav Kaznacheev
2017/05/23 23:48:56
Done.
| |
84 the annotation_features object becomes inert. | |
85 | |
86 If the annotation_features object is destroyed, the annotation_featu res state | |
reveman
2017/05/23 16:41:06
nit: ditto
Vladislav Kaznacheev
2017/05/23 23:48:56
Done.
| |
87 is removed from the wl_surface. The change will be applied on the ne xt | |
88 wl_surface.commit. | |
89 </description> | |
90 | |
91 <request name="destroy" type="destructor"> | |
92 <description summary="remove annotation_features from the surface"> | |
93 The associated wl_surface's annotation_features state is removed . | |
94 The change is applied on the next wl_surface.commit. | |
95 </description> | |
96 </request> | |
97 | |
98 <enum name="input_mode"> | |
reveman
2017/05/23 16:41:06
nit: avoid this enum and just use a boolean as the
Vladislav Kaznacheev
2017/05/23 23:48:56
Done.
| |
99 <description summary="mode"> | |
100 Input mode: which types of input events should be handled by | |
101 the annotation layer. | |
102 </description> | |
103 <entry name="DEFAULT" value="0" summary="Handle all input events"/> | |
104 <entry name="STYLUS_ONLY" value="1" summary="Handle stylus only"/> | |
105 </enum> | |
106 | |
107 <request name="set_input_mode"> | |
reveman
2017/05/23 16:41:06
nit: how about set_stylus_only(bool enabled)?
Vladislav Kaznacheev
2017/05/23 23:48:56
Removed the parameter.
| |
108 <description summary="set the input mode"> | |
109 Set the input mode for the annotation layer associated with the | |
110 wl_surface. | |
111 </description> | |
112 <arg name="mode" type="uint" summary="the new input mode"/> | |
113 </request> | |
114 | |
115 </interface> | |
116 | |
117 </protocol> | |
OLD | NEW |