synaptics-properties.h revision 302b15bd 
1/*
2 * Copyright © 2008 Red Hat, Inc.
3 *
4 * Permission to use, copy, modify, distribute, and sell this software
5 * and its documentation for any purpose is hereby granted without
6 * fee, provided that the above copyright notice appear in all copies
7 * and that both that copyright notice and this permission notice
8 * appear in supporting documentation, and that the name of Red Hat
9 * not be used in advertising or publicity pertaining to distribution
10 * of the software without specific, written prior permission.  Red
11 * Hat makes no representations about the suitability of this software
12 * for any purpose.  It is provided "as is" without express or implied
13 * warranty.
14 *
15 * THE AUTHORS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
16 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
17 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
18 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
19 * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
20 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
21 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 *
23 * Authors: Peter Hutterer
24 */
25
26#ifndef _SYNAPTICS_PROPERTIES_H_
27#define _SYNAPTICS_PROPERTIES_H_
28
29/**
30 * Properties exported by the synaptics driver. These properties are
31 * recognized by the driver and will change its behavior when modified.
32 * For a description of what each property does, see synaptics.h.
33 */
34
35/* 32 bit, 4 values, left, right, top, bottom */
36#define SYNAPTICS_PROP_EDGES "Synaptics Edges"
37
38/* 32 bit, 3 values, low, high, press */
39#define SYNAPTICS_PROP_FINGER "Synaptics Finger"
40
41/* 32 bit */
42#define SYNAPTICS_PROP_TAP_TIME "Synaptics Tap Time"
43
44/* 32 bit */
45#define SYNAPTICS_PROP_TAP_MOVE "Synaptics Tap Move"
46
47/* 32 bit, 3 values, single touch timeout, max tapping time for double
48 * taps, duration of a single click  */
49#define SYNAPTICS_PROP_TAP_DURATIONS "Synaptics Tap Durations"
50
51/* 8 bit (BOOL) */
52#define SYNAPTICS_PROP_TAP_FAST "Synaptics Tap FastTap"
53
54/* 32 bit */
55#define SYNAPTICS_PROP_MIDDLE_TIMEOUT "Synaptics Middle Button Timeout"
56
57/* 32 bit */
58#define SYNAPTICS_PROP_TWOFINGER_PRESSURE "Synaptics Two-Finger Pressure"
59
60/* 32 bit */
61#define SYNAPTICS_PROP_TWOFINGER_WIDTH "Synaptics Two-Finger Width"
62
63/* 32 bit, 2 values, vert, horiz */
64#define SYNAPTICS_PROP_SCROLL_DISTANCE "Synaptics Scrolling Distance"
65
66/* 8 bit (BOOL), 3 values, vertical, horizontal, corner */
67#define SYNAPTICS_PROP_SCROLL_EDGE "Synaptics Edge Scrolling"
68
69/* 8 bit (BOOL), 2 values, vertical, horizontal */
70#define SYNAPTICS_PROP_SCROLL_TWOFINGER "Synaptics Two-Finger Scrolling"
71
72/* FLOAT, 4 values, min, max, accel, trackstick */
73#define SYNAPTICS_PROP_SPEED "Synaptics Move Speed"
74
75/* 32 bit, 2 values, min, max */
76#define SYNAPTICS_PROP_EDGEMOTION_PRESSURE "Synaptics Edge Motion Pressure"
77
78/* 32 bit, 2 values, min, max */
79#define SYNAPTICS_PROP_EDGEMOTION_SPEED "Synaptics Edge Motion Speed"
80
81/* 8 bit (BOOL) */
82#define SYNAPTICS_PROP_EDGEMOTION "Synaptics Edge Motion Always"
83
84/* 8 bit (BOOL), 2 values, updown, leftright */
85#define SYNAPTICS_PROP_BUTTONSCROLLING "Synaptics Button Scrolling"
86
87/* 8 bit (BOOL), 2 values, updown, leftright */
88#define SYNAPTICS_PROP_BUTTONSCROLLING_REPEAT "Synaptics Button Scrolling Repeat"
89
90/* 32 bit */
91#define SYNAPTICS_PROP_BUTTONSCROLLING_TIME "Synaptics Button Scrolling Time"
92
93/* 8 bit, valid values (0, 1, 2) */
94#define SYNAPTICS_PROP_OFF "Synaptics Off"
95
96/* 8 bit (BOOL) */
97#define SYNAPTICS_PROP_GUESTMOUSE "Synaptics Guestmouse Off"
98
99/* 8 bit (BOOL) */
100#define SYNAPTICS_PROP_LOCKED_DRAGS "Synaptics Locked Drags"
101
102/* 32 bit */
103#define SYNAPTICS_PROP_LOCKED_DRAGS_TIMEOUT "Synaptics Locked Drags Timeout"
104
105/* 8 bit, up to MAX_TAP values (see synaptics.h), 0 disables an
106 * element. order: RT, RB, LT, LB, F1, F2, F3 */
107#define SYNAPTICS_PROP_TAP_ACTION "Synaptics Tap Action"
108
109/* 8 bit, up to MAX_CLICK values (see synaptics.h), 0 disables an
110 * element. order: Finger 1, 2, 3 */
111#define SYNAPTICS_PROP_CLICK_ACTION "Synaptics Click Action"
112
113/* 8 bit (BOOL) */
114#define SYNAPTICS_PROP_CIRCULAR_SCROLLING "Synaptics Circular Scrolling"
115
116/* FLOAT */
117#define SYNAPTICS_PROP_CIRCULAR_SCROLLING_DIST "Synaptics Circular Scrolling Distance"
118
119/* 8 bit, valid values 0..8 (inclusive)
120 * order: any edge, top, top + right, right, right + bottom, bottom, bottom +
121 * left, left, left  + top */
122#define SYNAPTICS_PROP_CIRCULAR_SCROLLING_TRIGGER "Synaptics Circular Scrolling Trigger"
123
124/* 8 bit (BOOL) */
125#define SYNAPTICS_PROP_CIRCULAR_PAD "Synaptics Circular Pad"
126
127/* 8 bit (BOOL) */
128#define SYNAPTICS_PROP_PALM_DETECT "Synaptics Palm Detection"
129
130/* 32 bit, 2 values, width, z */
131#define SYNAPTICS_PROP_PALM_DIMENSIONS "Synaptics Palm Dimensions"
132
133/* FLOAT, 2 values, speed, friction */
134#define SYNAPTICS_PROP_COASTING_SPEED "Synaptics Coasting Speed"
135
136/* 32 bit, 2 values, min, max */
137#define SYNAPTICS_PROP_PRESSURE_MOTION "Synaptics Pressure Motion"
138
139/* FLOAT, 2 values, min, max */
140#define SYNAPTICS_PROP_PRESSURE_MOTION_FACTOR "Synaptics Pressure Motion Factor"
141
142/* 8 bit (BOOL) */
143#define SYNAPTICS_PROP_GRAB "Synaptics Grab Event Device"
144
145/* 8 bit (BOOL), 1 value, tap-and-drag */
146#define SYNAPTICS_PROP_GESTURES "Synaptics Gestures"
147
148/* 8 bit (BOOL), 7 values (read-only), has_left, has_middle, has_right,
149 * has_double, has_triple, has_pressure, has_width */
150#define SYNAPTICS_PROP_CAPABILITIES "Synaptics Capabilities"
151
152/* 32 bit unsigned, 2 values, vertical, horizontal in units/millimeter */
153#define SYNAPTICS_PROP_RESOLUTION "Synaptics Pad Resolution"
154
155/* 32 bit, 4 values, left, right, top, bottom */
156#define SYNAPTICS_PROP_AREA "Synaptics Area"
157
158/* 32 Bit Integer, 2 values, horizontal hysteresis, vertical hysteresis */
159#define SYNAPTICS_PROP_NOISE_CANCELLATION "Synaptics Noise Cancellation"
160
161#endif /* _SYNAPTICS_PROPERTIES_H_ */
162