summaryrefslogtreecommitdiffstats
path: root/chromium/third_party/wayland-protocols/include/protocol/stylus-tools-unstable-v1-server-protocol.h
blob: b1b117e206e154565e858777a54abf0b3dec305f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/* Generated by wayland-scanner 1.13.0 */

#ifndef STYLUS_TOOLS_UNSTABLE_V1_SERVER_PROTOCOL_H
#define STYLUS_TOOLS_UNSTABLE_V1_SERVER_PROTOCOL_H

#include <stdint.h>
#include <stddef.h>
#include "wayland-server.h"

#ifdef  __cplusplus
extern "C" {
#endif

struct wl_client;
struct wl_resource;

/**
 * @page page_stylus_tools_unstable_v1 The stylus_tools_unstable_v1 protocol
 * Protocol for the stylus tools
 *
 * @section page_desc_stylus_tools_unstable_v1 Description
 *
 * This protocol specifies a set of interfaces used to control the behavior
 * of stylus tools.
 *
 * 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.
 *
 * @section page_ifaces_stylus_tools_unstable_v1 Interfaces
 * - @subpage page_iface_zcr_stylus_tools_v1 - stylus_tools
 * - @subpage page_iface_zcr_stylus_tool_v1 - stylus_tool interface to a wl_surface
 * @section page_copyright_stylus_tools_unstable_v1 Copyright
 * <pre>
 *
 * Copyright 2017 The Chromium Authors.
 *
 * 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.
 * </pre>
 */
struct wl_surface;
struct zcr_stylus_tool_v1;
struct zcr_stylus_tools_v1;

/**
 * @page page_iface_zcr_stylus_tools_v1 zcr_stylus_tools_v1
 * @section page_iface_zcr_stylus_tools_v1_desc Description
 *
 * The global interface is used to instantiate an interface extension for a
 * wl_surface object. This extended interface will then allow the client to
 * control the stylus-related behavior for input device event processing
 * related to wl_surface.
 * @section page_iface_zcr_stylus_tools_v1_api API
 * See @ref iface_zcr_stylus_tools_v1.
 */
/**
 * @defgroup iface_zcr_stylus_tools_v1 The zcr_stylus_tools_v1 interface
 *
 * The global interface is used to instantiate an interface extension for a
 * wl_surface object. This extended interface will then allow the client to
 * control the stylus-related behavior for input device event processing
 * related to wl_surface.
 */
extern const struct wl_interface zcr_stylus_tools_v1_interface;
/**
 * @page page_iface_zcr_stylus_tool_v1 zcr_stylus_tool_v1
 * @section page_iface_zcr_stylus_tool_v1_desc Description
 *
 * An additional interface to a wl_surface object, which allows the
 * client to control the behavior of stylus tools.
 *
 * If the wl_surface associated with the stylus_tool object is destroyed,
 * the stylus_tool object becomes inert.
 *
 * If the stylus_tool object is destroyed, the stylus_tool state is removed
 * from the wl_surface. The change will be applied on the next
 * wl_surface.commit.
 * @section page_iface_zcr_stylus_tool_v1_api API
 * See @ref iface_zcr_stylus_tool_v1.
 */
/**
 * @defgroup iface_zcr_stylus_tool_v1 The zcr_stylus_tool_v1 interface
 *
 * An additional interface to a wl_surface object, which allows the
 * client to control the behavior of stylus tools.
 *
 * If the wl_surface associated with the stylus_tool object is destroyed,
 * the stylus_tool object becomes inert.
 *
 * If the stylus_tool object is destroyed, the stylus_tool state is removed
 * from the wl_surface. The change will be applied on the next
 * wl_surface.commit.
 */
extern const struct wl_interface zcr_stylus_tool_v1_interface;

#ifndef ZCR_STYLUS_TOOLS_V1_ERROR_ENUM
#define ZCR_STYLUS_TOOLS_V1_ERROR_ENUM
enum zcr_stylus_tools_v1_error {
	/**
	 * the surface already has a stylus_tool object associated
	 */
	ZCR_STYLUS_TOOLS_V1_ERROR_STYLUS_TOOL_EXISTS = 0,
};
#endif /* ZCR_STYLUS_TOOLS_V1_ERROR_ENUM */

/**
 * @ingroup iface_zcr_stylus_tools_v1
 * @struct zcr_stylus_tools_v1_interface
 */
struct zcr_stylus_tools_v1_interface {
	/**
	 * unbind from the stylus_tools interface
	 *
	 * Informs the server that the client will not be using this
	 * protocol object anymore. This does not affect any other objects,
	 * stylus_tool objects included.
	 */
	void (*destroy)(struct wl_client *client,
			struct wl_resource *resource);
	/**
	 * extend surface interface for stylus_tool
	 *
	 * Instantiate an interface extension for the given wl_surface to
	 * provide access to the stylus tools features. If the given
	 * wl_surface already has an stylus_tool object associated, the
	 * stylus_tool_exists protocol protocol error is raised.
	 * @param id the new stylus_tool interface id
	 * @param surface the surface
	 */
	void (*get_stylus_tool)(struct wl_client *client,
				struct wl_resource *resource,
				uint32_t id,
				struct wl_resource *surface);
};


/**
 * @ingroup iface_zcr_stylus_tools_v1
 */
#define ZCR_STYLUS_TOOLS_V1_DESTROY_SINCE_VERSION 1
/**
 * @ingroup iface_zcr_stylus_tools_v1
 */
#define ZCR_STYLUS_TOOLS_V1_GET_STYLUS_TOOL_SINCE_VERSION 1

/**
 * @ingroup iface_zcr_stylus_tool_v1
 * @struct zcr_stylus_tool_v1_interface
 */
struct zcr_stylus_tool_v1_interface {
	/**
	 * remove stylus_tool from the surface
	 *
	 * The associated wl_surface's stylus_tool state is removed. The
	 * change is applied on the next wl_surface.commit.
	 */
	void (*destroy)(struct wl_client *client,
			struct wl_resource *resource);
	/**
	 * Set the stylus-only mode
	 *
	 * Enables the "stylus-only" mode for input device event
	 * processing related to wl_surface.
	 */
	void (*set_stylus_only)(struct wl_client *client,
				struct wl_resource *resource);
};


/**
 * @ingroup iface_zcr_stylus_tool_v1
 */
#define ZCR_STYLUS_TOOL_V1_DESTROY_SINCE_VERSION 1
/**
 * @ingroup iface_zcr_stylus_tool_v1
 */
#define ZCR_STYLUS_TOOL_V1_SET_STYLUS_ONLY_SINCE_VERSION 1

#ifdef  __cplusplus
}
#endif

#endif