summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/efl_input_types.eot
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/evas/canvas/efl_input_types.eot')
-rw-r--r--src/lib/evas/canvas/efl_input_types.eot178
1 files changed, 178 insertions, 0 deletions
diff --git a/src/lib/evas/canvas/efl_input_types.eot b/src/lib/evas/canvas/efl_input_types.eot
new file mode 100644
index 0000000..a716686
--- /dev/null
+++ b/src/lib/evas/canvas/efl_input_types.eot
@@ -0,0 +1,178 @@
1enum Efl.Pointer.Action
2{
3 [[Pointer event type. Represents which kind of event this is.
4
5 @since 1.19
6 ]]
7 none, [[Not a valid event, or nothing new happened (eg. when querying
8 current state of touch points).]]
9 move, [[Mouse or equivalent pointer moved.]]
10 down, [[Mouse button or equivalent pointer pressed down.
11 Always followed by up or cancel.]]
12 up, [[Mouse button or equivalent pointer released. See also cancel.]]
13 cancel, [[Special event happening after a down if the up counterpart
14 can not happen (eg. another window forcibly stole the focus).]]
15 in, [[Mouse or pointer entered the object.]]
16 out, [[Mouse or pointer exited the object.]]
17 wheel, [[Mouse wheel scroll, horizontally or vertically.]]
18 axis, [[Axis event (pen, stick, ...).]]
19}
20
21enum Efl.Pointer.Flags
22{
23 [[Pointer flags indicating whether a double or triple click is under way.
24
25 @since 1.19
26 ]]
27 none = 0, [[No extra mouse button data]]
28 double_click = (1 << 0), [[This mouse button press was the 2nd press of a double click]]
29 triple_click = (1 << 1), [[This mouse button press was the 3rd press of a triple click]]
30}
31
32enum Efl.Input.Flags
33{
34 [[Special flags set during an input event propagation.
35
36 @since 1.19
37 ]]
38 none = 0, [[No fancy flags set]]
39 processed = (1 << 0), [[This event is being delivered and has been processed,
40 so it should be put "on hold" until the flag is unset.
41 The event should be used for informational purposes
42 and maybe some indications visually, but not
43 actually perform anything.]]
44 scrolling = (1 << 1), [[This event flag indicates the event occurs while
45 scrolling; for example, DOWN event occurs during
46 scrolling. The event should be used for informational
47 purposes and maybe some indications visually, but not
48 actually perform anything.]]
49}
50
51enum @beta Efl.Input.Object_Pointer_Mode {
52 [[How the mouse pointer should be handled by EFL.
53
54 In the mode $autograb, when a mouse button is pressed down over an
55 object and held down, with the mouse pointer being moved outside of it,
56 the pointer still behaves as being bound to that object, albeit out
57 of its drawing region. When the button is released, the event will
58 be fed to the object, that may check if the final position is over it
59 or not and do something about it.
60
61 In the mode $nograb, the pointer will always be bound to the object
62 right below it.
63
64 @since 1.19
65 ]]
66 auto_grab, [[Default, X11-like.]]
67 no_grab, [[Pointer always bound to the object right below it.]]
68 no_grab_no_repeat_updown [[Useful on object with "repeat events" enabled,
69 where mouse/touch up and down events WON'T be
70 repeated to objects and these objects wont be
71 auto-grabbed.
72
73 @since 1.2
74 ]]
75}
76
77enum @beta Efl.Input.Value {
78 [[Keys for the generic values of all events.
79
80 @since 1.19
81 ]]
82 none, [[Not a valid value type.]]
83 timestamp, [[Timestamp of this event in seconds.]]
84 button, [[ID of the button that triggered this event (unsigned int).
85 Prefer the method $button to read this value. Default: 0.]]
86 buttons_pressed, [[32-bit bit mask (unsigned int). Prefer the
87 method $buttons_pressed to read this value. Default: 0.]]
88 touch_id, [[ID of the finger or tool (eg. pen) that triggered this event.
89 Prefer the property $touch_id to read this value. Default: 0.]]
90 x, [[Absolute X position where this event occurred, in pixels.
91 Relative to the window. Default: last known position.
92 This value may be smoothed out or even extrapolated by EFL.]]
93 y, [[Absolute Y position where this event occurred, in pixels.
94 Relative to the window. Default: last known position.
95 This value may be smoothed out or even extrapolated by EFL.]]
96 dx, [[Relative X movement, in pixels. Range: unbounded. Default: 0.]]
97 dy, [[Relative Y movement, in pixels. Range: unbounded. Default: 0.]]
98 previous_x, [[Previous X position of the pointer, in pixels.
99 Default: last known position, may be equal to x.]]
100 previous_y, [[Previous Y position of the pointer, in pixels.
101 Default: last known position, may be equal to y.]]
102 raw_x, [[Absolute X position where this event occurred. Default: 0.
103 This value will be set from the hardware input without any
104 smoothing or extrapolation. For an axis input event, this is
105 the raw value set by the driver (undefined range and unit).]]
106 raw_y, [[Absolute X position where this event occurred. Default: 0.
107 This value will be set from the hardware input without any
108 smoothing or extrapolation. For an axis input event, this is
109 the raw value set by the driver (undefined range and unit).]]
110 radius, [[Average radius of the pressed area under a finger or tool,
111 in pixels. Default is 1.]]
112 radius_x, [[Spread over X of the pressed area under a finger or tool,
113 in pixels. Default is 1.]]
114 radius_y, [[Spread over Y of the pressed area under a finger or tool,
115 in pixels. Default is 1.]]
116 pressure, [[Pressure applied to the button, touch or pen tip.
117 Range: [0, 1]. Default is 1.]]
118 distance, [[Relative distance along physical Z axis. Range: [0, 1].
119 Default is 0.]]
120 azimuth, [[Angle of tool about the Z axis from positive X axis.
121 Range: [-PI, PI]. Unit: Radians.]]
122 tilt, [[Angle of tool about plane of sensor from positive Z axis.
123 Range: [0.0, PI]. Unit: Radians.]]
124 tilt_x, [[Current tilt along the X axis of the tablet's current logical
125 orientation, in radians off the tablet's Z axis.
126 Range: [-PI, PI]. Unit: Radians.]]
127 tilt_y, [[Current tilt along the Y axis of the tablet's current logical
128 orientation, in radians off the tablet's Z axis.
129 Range: [-PI, PI]. Unit: Radians.]]
130 twist, [[Rotation of tool about its major axis from its "natural"
131 position. Range: [-PI, PI] Unit: Radians.]]
132 wheel_delta, [[Delta movement of the wheel in discrete steps (int).
133 Default: 0.]]
134 wheel_angle, [[Delta movement of the wheel in radians. Default: 0.]]
135 wheel_horizontal, [[Direction of the wheel (horizontal = 1 or vertical = 0).
136 Default: 0. Prefer the property $wheel_horizontal to read.]]
137 slider, [[Current position of the slider on the tool. Range: [-1, 1].
138 Default: 0.]]
139}
140
141enum Efl.Input.Modifier {
142 [[Key modifiers such as Control, Alt, etc...
143
144 This enum may be used as a bitmask with OR operations, depending on the
145 API.
146
147 The available keys may vary depending on the physical keyboard layout, or
148 language and keyboard settings, or depending on the platform.
149
150 @since 1.20
151 ]]
152 none = 0, [[No key modifier]]
153 alt = 1 << 0, [[Alt key modifier]]
154 control = 1 << 1, [[Control key modifier ("Ctrl" key)]]
155 shift = 1 << 2, [[Shift key modifier]]
156 meta = 1 << 3, [[Meta key modifier (often the "Windows" key)]]
157 altgr = 1 << 4, [[AltGr key modifier (not present on all keyboards)]]
158 hyper = 1 << 5, [[Hyper key modifier (may be "Windows" key)]]
159 super = 1 << 6, [[Super key modifier (may be "Windows" key)]]
160}
161
162enum Efl.Input.Lock {
163 [[Key locks such as Num Lock, Scroll Lock and Caps Lock.
164
165 This enum may be used as a bitmask with OR operations, depending on the
166 API.
167
168 The available keys may vary depending on the physical keyboard layout, or
169 language and keyboard settings, or depending on the platform.
170
171 @since 1.20
172 ]]
173 none = 0, [[No key modifier]]
174 num = 1 << 0, [[Num Lock for numeric key pad use]]
175 caps = 1 << 1, [[Caps Lock for writing in all caps]]
176 scroll = 1 << 2, [[Scroll Lock]]
177 shift = 1 << 3, [[Shift Lock]]
178}