Mir
Main Page
Related Pages
Modules
Namespaces
Classes
Files
Examples
File List
File Members
include
client
mir_toolkit
events
input
touch_event.h
Go to the documentation of this file.
1
/*
2
* Copyright © 2014 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
* Authored by: Robert Carr <robert.carr@canonical.com>
17
*/
18
19
#ifndef MIR_TOOLKIT_TOUCH_EVENT_H_
20
#define MIR_TOOLKIT_TOUCH_EVENT_H_
21
22
#ifdef __cplusplus
23
27
extern
"C"
{
28
#endif
29
33
typedef
struct
MirTouchEvent
MirTouchEvent
;
34
40
typedef
int32_t
MirTouchId
;
41
45
typedef
enum
{
46
/* This touch point is going up */
47
mir_touch_action_up
= 0,
48
/* This touch point is going down */
49
mir_touch_action_down
= 1,
50
/* Axis values have changed on this touch point */
51
mir_touch_action_change
= 2,
52
53
mir_touch_actions
54
}
MirTouchAction
;
55
59
typedef
enum
{
60
/* Axis representing the x coordinate for the touch */
61
mir_touch_axis_x
= 0,
62
/* Axis representing the y coordinate for the touch */
63
mir_touch_axis_y
= 1,
64
/* Axis representing pressure of the touch */
65
mir_touch_axis_pressure
= 2,
66
/* Axis representing the length of the major axis of an ellipse
67
centered at the touch point */
68
mir_touch_axis_touch_major
= 3,
69
/* Axis representing the length of the minor axis of an ellipse
70
centered at the touch point */
71
mir_touch_axis_touch_minor
= 4,
72
/* Axis representing the diameter of a circle centered on the touch
73
point */
74
mir_touch_axis_size
= 5,
75
76
mir_touch_axes
77
}
MirTouchAxis
;
78
82
typedef
enum
{
83
// Tool type could not be determined
84
mir_touch_tooltype_unknown
= 0,
85
// Touch is made with a finger
86
mir_touch_tooltype_finger
= 1,
87
// Touch is made with a stylus
88
mir_touch_tooltype_stylus
= 2,
89
90
mir_touch_tooltypes
91
}
MirTouchTooltype
;
92
99
MirInputEventModifiers
mir_touch_event_modifiers
(
MirTouchEvent
const
* event);
100
108
unsigned
int
mir_touch_event_point_count
(
MirTouchEvent
const
* event);
109
117
MirTouchId
mir_touch_event_id
(
MirTouchEvent
const
* event,
size_t
touch_index);
118
126
MirTouchAction
mir_touch_event_action
(
MirTouchEvent
const
* event,
size_t
touch_index);
127
135
MirTouchTooltype
mir_touch_event_tooltype
(
MirTouchEvent
const
* event,
136
size_t
touch_index);
137
138
147
float
mir_touch_event_axis_value
(
MirTouchEvent
const
* event,
148
size_t
touch_index, MirTouchAxis axis);
149
156
MirInputEvent
const
*
mir_touch_event_input_event
(
MirTouchEvent
const
* event);
157
158
#ifdef __cplusplus
159
}
161
#endif
162
163
#endif
/* MIR_TOOLKIT_TOUCH_EVENT_H_ */
mir_touch_axis_touch_minor
Definition:
touch_event.h:71
mir_touch_action_down
Definition:
touch_event.h:49
mir_touch_event_axis_value
float mir_touch_event_axis_value(MirTouchEvent const *event, size_t touch_index, MirTouchAxis axis)
Retrieve the axis value for a given axis on an indexed touch.
mir_touch_axes
Definition:
touch_event.h:76
mir_touch_axis_touch_major
Definition:
touch_event.h:68
mir_touch_event_point_count
unsigned int mir_touch_event_point_count(MirTouchEvent const *event)
Retrieve the number of touches reported for a given touch event.
mir_touch_axis_size
Definition:
touch_event.h:74
MirTouchId
int32_t MirTouchId
An identifier for a touch-point.
Definition:
touch_event.h:40
mir_touch_axis_x
Definition:
touch_event.h:61
MirTouchAxis
MirTouchAxis
Identifiers for touch axis.
Definition:
touch_event.h:59
mir_touch_event_input_event
MirInputEvent const * mir_touch_event_input_event(MirTouchEvent const *event)
Retrieve the corresponding input event.
mir_touch_tooltype_stylus
Definition:
touch_event.h:88
MirInputEventModifiers
unsigned int MirInputEventModifiers
Definition:
input_event.h:67
mir_touch_action_up
Definition:
touch_event.h:47
MirTouchEvent
struct MirTouchEvent MirTouchEvent
An event type describing a change in touch device state.
Definition:
touch_event.h:33
mir_touch_axis_y
Definition:
touch_event.h:63
mir_touch_tooltypes
Definition:
touch_event.h:90
mir_touch_event_tooltype
MirTouchTooltype mir_touch_event_tooltype(MirTouchEvent const *event, size_t touch_index)
Retrieve the tooltype for touch at given index.
MirTouchTooltype
MirTouchTooltype
Identifiers for per-touch tool types.
Definition:
touch_event.h:82
mir_touch_action_change
Definition:
touch_event.h:51
mir_touch_axis_pressure
Definition:
touch_event.h:65
MirInputEvent
struct MirInputEvent MirInputEvent
Definition:
event.h:70
mir_touch_event_modifiers
MirInputEventModifiers mir_touch_event_modifiers(MirTouchEvent const *event)
Retrieve the modifier keys pressed when the touch action occured.
MirTouchAction
MirTouchAction
Possible per touch actions for state changing.
Definition:
touch_event.h:45
mir_touch_event_id
MirTouchId mir_touch_event_id(MirTouchEvent const *event, size_t touch_index)
Retrieve the TouchID for a touch at given index.
mir_touch_tooltype_unknown
Definition:
touch_event.h:84
mir_touch_event_action
MirTouchAction mir_touch_event_action(MirTouchEvent const *event, size_t touch_index)
Retrieve the action which occured for a touch at given index.
mir_touch_actions
Definition:
touch_event.h:53
mir_touch_tooltype_finger
Definition:
touch_event.h:86
Copyright © 2012-2016 Canonical Ltd.
Generated on Fri Dec 20 06:52:43 UTC 2019