summaryrefslogtreecommitdiffstats
path: root/chromium/third_party/wayland-protocols/include/protocol/keyboard-configuration-unstable-v1-server-protocol.h
blob: bf17f5efd0ee3813988a39101aa8ac360de239f1 (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
/* Generated by wayland-scanner 1.13.0 */

#ifndef KEYBOARD_CONFIGURATION_UNSTABLE_V1_SERVER_PROTOCOL_H
#define KEYBOARD_CONFIGURATION_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_keyboard_configuration_unstable_v1 The keyboard_configuration_unstable_v1 protocol
 * @section page_ifaces_keyboard_configuration_unstable_v1 Interfaces
 * - @subpage page_iface_zcr_keyboard_configuration_v1 - extends wl_keyboard with events for device configuration change
 * - @subpage page_iface_zcr_keyboard_device_configuration_v1 - extension of wl_keyboard protocol
 * @section page_copyright_keyboard_configuration_unstable_v1 Copyright
 * <pre>
 *
 * Copyright 2016 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_keyboard;
struct zcr_keyboard_configuration_v1;
struct zcr_keyboard_device_configuration_v1;

/**
 * @page page_iface_zcr_keyboard_configuration_v1 zcr_keyboard_configuration_v1
 * @section page_iface_zcr_keyboard_configuration_v1_desc Description
 *
 * Allows a wl_keyboard to notify device configuration change events of
 * the keyboard to the client.
 *
 * 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 uinterface version bump.
 * Backward incompatible changes are done by bumping the version number in
 * the protocol and uinterface 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_iface_zcr_keyboard_configuration_v1_api API
 * See @ref iface_zcr_keyboard_configuration_v1.
 */
/**
 * @defgroup iface_zcr_keyboard_configuration_v1 The zcr_keyboard_configuration_v1 interface
 *
 * Allows a wl_keyboard to notify device configuration change events of
 * the keyboard to the client.
 *
 * 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 uinterface version bump.
 * Backward incompatible changes are done by bumping the version number in
 * the protocol and uinterface 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.
 */
extern const struct wl_interface zcr_keyboard_configuration_v1_interface;
/**
 * @page page_iface_zcr_keyboard_device_configuration_v1 zcr_keyboard_device_configuration_v1
 * @section page_iface_zcr_keyboard_device_configuration_v1_desc Description
 *
 * The zcr_keyboard_device_configuration_v1 interface extends the wl_keyboard
 * interface with events to describe device configuration of a keyboard.
 * @section page_iface_zcr_keyboard_device_configuration_v1_api API
 * See @ref iface_zcr_keyboard_device_configuration_v1.
 */
/**
 * @defgroup iface_zcr_keyboard_device_configuration_v1 The zcr_keyboard_device_configuration_v1 interface
 *
 * The zcr_keyboard_device_configuration_v1 interface extends the wl_keyboard
 * interface with events to describe device configuration of a keyboard.
 */
extern const struct wl_interface zcr_keyboard_device_configuration_v1_interface;

#ifndef ZCR_KEYBOARD_CONFIGURATION_V1_ERROR_ENUM
#define ZCR_KEYBOARD_CONFIGURATION_V1_ERROR_ENUM
enum zcr_keyboard_configuration_v1_error {
	/**
	 * the keyboard already has a device configuration object associated
	 */
	ZCR_KEYBOARD_CONFIGURATION_V1_ERROR_DEVICE_CONFIGURATION_EXISTS = 0,
};
#endif /* ZCR_KEYBOARD_CONFIGURATION_V1_ERROR_ENUM */

/**
 * @ingroup iface_zcr_keyboard_configuration_v1
 * @struct zcr_keyboard_configuration_v1_interface
 */
struct zcr_keyboard_configuration_v1_interface {
	/**
	 * get keyboard_device_configuration interface for a keyboard
	 *
	 * Create keyboard_device_configuration object. See
	 * zcr_keyboard_device_configuration interface for details. If the
	 * given wl_keyboard object already has a device configuration
	 * object associated, the keyboard_device_configuration_exists
	 * protocol error is raised.
	 */
	void (*get_keyboard_device_configuration)(struct wl_client *client,
						  struct wl_resource *resource,
						  uint32_t id,
						  struct wl_resource *keyboard);
};


/**
 * @ingroup iface_zcr_keyboard_configuration_v1
 */
#define ZCR_KEYBOARD_CONFIGURATION_V1_GET_KEYBOARD_DEVICE_CONFIGURATION_SINCE_VERSION 1

#ifndef ZCR_KEYBOARD_DEVICE_CONFIGURATION_V1_KEYBOARD_TYPE_ENUM
#define ZCR_KEYBOARD_DEVICE_CONFIGURATION_V1_KEYBOARD_TYPE_ENUM
/**
 * @ingroup iface_zcr_keyboard_device_configuration_v1
 * keyboard types
 */
enum zcr_keyboard_device_configuration_v1_keyboard_type {
	/**
	 * Physical keyboard
	 */
	ZCR_KEYBOARD_DEVICE_CONFIGURATION_V1_KEYBOARD_TYPE_PHYSICAL = 0,
	/**
	 * Virtual keyboard
	 */
	ZCR_KEYBOARD_DEVICE_CONFIGURATION_V1_KEYBOARD_TYPE_VIRTUAL = 1,
};
#endif /* ZCR_KEYBOARD_DEVICE_CONFIGURATION_V1_KEYBOARD_TYPE_ENUM */

/**
 * @ingroup iface_zcr_keyboard_device_configuration_v1
 * @struct zcr_keyboard_device_configuration_v1_interface
 */
struct zcr_keyboard_device_configuration_v1_interface {
	/**
	 * destroy keyboard_device_configuration object
	 *
	 * 
	 */
	void (*destroy)(struct wl_client *client,
			struct wl_resource *resource);
};

#define ZCR_KEYBOARD_DEVICE_CONFIGURATION_V1_TYPE_CHANGE 0

/**
 * @ingroup iface_zcr_keyboard_device_configuration_v1
 */
#define ZCR_KEYBOARD_DEVICE_CONFIGURATION_V1_TYPE_CHANGE_SINCE_VERSION 1

/**
 * @ingroup iface_zcr_keyboard_device_configuration_v1
 */
#define ZCR_KEYBOARD_DEVICE_CONFIGURATION_V1_DESTROY_SINCE_VERSION 1

/**
 * @ingroup iface_zcr_keyboard_device_configuration_v1
 * Sends an type_change event to the client owning the resource.
 * @param resource_ The client's resource
 * @param type new device type
 */
static inline void
zcr_keyboard_device_configuration_v1_send_type_change(struct wl_resource *resource_, uint32_t type)
{
	wl_resource_post_event(resource_, ZCR_KEYBOARD_DEVICE_CONFIGURATION_V1_TYPE_CHANGE, type);
}

#ifdef  __cplusplus
}
#endif

#endif