Mir
include
client
mir_toolkit
mir_input_device.h
Go to the documentation of this file.
1
/*
2
* Copyright © 2015-2016 Canonical Ltd.
3
*
4
* This program is free software: you can redistribute it and/or modify it
5
* under the terms of the GNU Lesser General Public License version 3,
6
* as published by the Free Software Foundation.
7
*
8
* This program is distributed in the hope that it will be useful,
9
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
* GNU Lesser General Public License for more details.
12
*
13
* You should have received a copy of the GNU Lesser General Public License
14
* along with this program. If not, see <http://www.gnu.org/licenses/>.
15
*
16
*/
17
18
#ifndef MIR_TOOLKIT_MIR_INPUT_DEVICE_H_
19
#define MIR_TOOLKIT_MIR_INPUT_DEVICE_H_
20
21
#include "
mir_toolkit/client_types.h
"
22
27
#ifdef __cplusplus
28
extern
"C"
{
29
#endif
30
31
typedef
enum
MirPointerHandedness
32
{
33
mir_pointer_handedness_right
= 0,
34
mir_pointer_handedness_left
= 1
35
}
MirPointerHandedness
;
36
46
typedef
enum
MirPointerAcceleration
47
{
48
mir_pointer_acceleration_none
= 1,
49
mir_pointer_acceleration_adaptive
= 2
50
}
MirPointerAcceleration
;
51
52
typedef
enum
MirTouchpadClickMode
53
{
54
mir_touchpad_click_mode_none
= 0,
55
mir_touchpad_click_mode_area_to_click
= 1 << 0,
56
mir_touchpad_click_mode_finger_count
= 1 << 1
57
}
MirTouchpadClickMode
;
58
typedef
unsigned
int
MirTouchpadClickModes
;
59
60
typedef
enum
MirTouchpadScrollMode
61
{
62
mir_touchpad_scroll_mode_none
= 0,
63
mir_touchpad_scroll_mode_two_finger_scroll
= 1 << 0,
64
mir_touchpad_scroll_mode_edge_scroll
= 1 << 1,
65
mir_touchpad_scroll_mode_button_down_scroll
= 1 << 2
66
}
MirTouchpadScrollMode
;
67
typedef
unsigned
int
MirTouchpadScrollModes
;
68
69
enum
MirInputDeviceCapability
70
{
71
mir_input_device_capability_none
= 0,
72
mir_input_device_capability_pointer
= 1<<1,
73
mir_input_device_capability_keyboard
= 1<<2,
74
mir_input_device_capability_touchpad
= 1<<3,
75
mir_input_device_capability_touchscreen
= 1<<4,
76
mir_input_device_capability_gamepad
= 1<<5,
77
mir_input_device_capability_joystick
= 1<<6,
78
mir_input_device_capability_switch
= 1<<7,
79
mir_input_device_capability_multitouch
= 1<<8,
80
mir_input_device_capability_alpha_numeric
= 1<<9
81
};
82
typedef
unsigned
int
MirInputDeviceCapabilities
;
83
91
size_t
mir_input_config_device_count
(
MirInputConfig
const
* config);
92
103
MirInputDevice
const
*
mir_input_config_get_device
(
104
MirInputConfig
const
* config,
105
size_t
index);
106
119
MirInputDevice
const
*
mir_input_config_get_device_by_id
(
120
MirInputConfig
const
* config,
121
MirInputDeviceId
id
);
122
133
MirInputDevice
*
mir_input_config_get_mutable_device
(
134
MirInputConfig
* config,
135
size_t
index);
136
149
MirInputDevice
*
mir_input_config_get_mutable_device_by_id
(
150
MirInputConfig
* config,
151
MirInputDeviceId
id
);
152
160
MirInputDeviceCapabilities
mir_input_device_get_capabilities
(
161
MirInputDevice
const
* device);
162
172
MirInputDeviceId
mir_input_device_get_id
(
MirInputDevice
const
* device);
173
183
char
const
*
mir_input_device_get_name
(
MirInputDevice
const
* device);
184
195
char
const
*
mir_input_device_get_unique_id
(
MirInputDevice
const
* device);
196
197
#ifdef __cplusplus
198
}
199
#endif
200
201
#endif
mir_pointer_handedness_left
Definition:
mir_input_device.h:34
mir_touchpad_scroll_mode_none
Definition:
mir_input_device.h:62
mir_input_device_capability_alpha_numeric
capable to detect multiple contacts
Definition:
mir_input_device.h:80
MirTouchpadScrollMode
MirTouchpadScrollMode
Definition:
mir_input_device.h:60
mir_touchpad_click_mode_area_to_click
Definition:
mir_input_device.h:55
mir_input_device_get_name
char const * mir_input_device_get_name(MirInputDevice const *device)
Retrieve the name of the input device.
MirInputDeviceCapabilities
unsigned int MirInputDeviceCapabilities
Definition:
mir_input_device.h:82
mir_input_device_capability_switch
Definition:
mir_input_device.h:78
mir_input_device_get_capabilities
MirInputDeviceCapabilities mir_input_device_get_capabilities(MirInputDevice const *device)
Retrieve the capabilities of the input device at the given index.
mir_input_config_get_mutable_device_by_id
MirInputDevice * mir_input_config_get_mutable_device_by_id(MirInputConfig *config, MirInputDeviceId id)
Retrieve the input device by id.
mir_input_config_get_device
MirInputDevice const * mir_input_config_get_device(MirInputConfig const *config, size_t index)
Retrieve the input device at given index.
MirInputDevice
struct MirInputDevice MirInputDevice
Definition:
client_types.h:362
mir_input_config_device_count
size_t mir_input_config_device_count(MirInputConfig const *config)
Retrieve the number of available input devices.
mir_input_device_capability_touchscreen
Definition:
mir_input_device.h:75
MirTouchpadClickModes
unsigned int MirTouchpadClickModes
Definition:
mir_input_device.h:58
mir_touchpad_click_mode_none
Definition:
mir_input_device.h:54
mir_touchpad_scroll_mode_two_finger_scroll
Definition:
mir_input_device.h:63
mir_pointer_handedness_right
Definition:
mir_input_device.h:33
mir_pointer_acceleration_adaptive
Definition:
mir_input_device.h:49
MirPointerHandedness
MirPointerHandedness
Definition:
mir_input_device.h:31
mir_pointer_acceleration_none
Definition:
mir_input_device.h:48
mir_input_device_get_unique_id
char const * mir_input_device_get_unique_id(MirInputDevice const *device)
Retrieve the unique id of the input device.
mir_input_device_capability_gamepad
Definition:
mir_input_device.h:76
MirInputDeviceId
int64_t MirInputDeviceId
Definition:
input_event.h:35
mir_input_device_capability_none
Definition:
mir_input_device.h:71
MirPointerAcceleration
MirPointerAcceleration
MirPointerAcceleration describes the way pointer movement is filtered:
Definition:
mir_input_device.h:46
client_types.h
MirTouchpadScrollModes
unsigned int MirTouchpadScrollModes
Definition:
mir_input_device.h:67
MirInputDeviceCapability
MirInputDeviceCapability
Definition:
mir_input_device.h:69
mir_input_config_get_mutable_device
MirInputDevice * mir_input_config_get_mutable_device(MirInputConfig *config, size_t index)
Retrieve the input device at given index.
mir_touchpad_scroll_mode_edge_scroll
Definition:
mir_input_device.h:64
MirTouchpadClickMode
MirTouchpadClickMode
Definition:
mir_input_device.h:52
mir_input_device_capability_multitouch
Definition:
mir_input_device.h:79
mir_input_device_capability_pointer
Definition:
mir_input_device.h:72
mir_input_device_get_id
MirInputDeviceId mir_input_device_get_id(MirInputDevice const *device)
Retrieve the device id of the input device.
mir_touchpad_click_mode_finger_count
Definition:
mir_input_device.h:56
mir_input_config_get_device_by_id
MirInputDevice const * mir_input_config_get_device_by_id(MirInputConfig const *config, MirInputDeviceId id)
Retrieve the input device by id.
mir_input_device_capability_touchpad
Definition:
mir_input_device.h:74
mir_input_device_capability_keyboard
Definition:
mir_input_device.h:73
MirInputConfig
struct MirInputConfig MirInputConfig
Definition:
client_types.h:361
mir_input_device_capability_joystick
Definition:
mir_input_device.h:77
mir_touchpad_scroll_mode_button_down_scroll
Definition:
mir_input_device.h:65
Copyright © 2012-2016 Canonical Ltd.
Generated on Sat Dec 3 12:48:59 UTC 2016