1
=== modified file 'src/ginn.pod'
2
--- src/ginn.pod	2011-01-26 15:46:43 +0000
3
+++ src/ginn.pod	2011-04-27 15:46:00 +0000
4
@@ -20,98 +20,109 @@
5
20
I<button>, you can add also up to 4 modifiers keys like I<Control_L>.
20
I<button>, you can add also up to 4 modifiers keys like I<Control_L>.
6
21
21
7
22
22
35
23
=head1 EXAMPLES
23
=head2 EXAMPLES
36
24
24
37
25
Sample wishes file
25
Sample wishes file:
38
26
26
39
27
= <ginn>
27
    <ginn>
40
28
=   <global>
28
    <global>
41
29
=     <wish gesture="Drag" fingers="2">
29
      <wish gesture="Drag" fingers="2">
42
30
=       <action name="action5" when="update">
30
        <action name="action5" when="update">
43
31
=         <trigger prop="delta y" min="20" max="80"/>
31
          <trigger prop="delta y" min="20" max="80"/>
44
32
=         <key>Down</key>
32
          <key>Down</key>
45
33
=       </action>
33
        </action>
46
34
=     </wish>
34
      </wish>
47
35
=   </global>
35
    </global>
48
36
=   <applications>
36
    <applications>
49
37
=     <application name="inkscape">
37
      <application name="inkscape">
50
38
=     <wish gesture="Pinch" fingers="2">
38
        <wish gesture="Pinch" fingers="2">
51
39
=       <action name="action1" when="update">
39
          <action name="action1" when="update">
52
40
=         <trigger prop="radius delta" min="-200" max="-40"/>
40
            <trigger prop="radius delta" min="-200" max="-40"/>
53
41
=         <key>KP_Subtract</key>
41
            <key>KP_Subtract</key>
54
42
=       </action>
42
          </action>
55
43
=     </wish>
43
        </wish>
56
44
=     </application>
44
      </application>
57
45
=   </applications>
45
    </applications>
58
46
= </ginn>
46
    </ginn>
59
47
47
60
48
48
61
49
Gesture type can be : Drag, Pinch, Rotate or Tap
49
Gesture type can be: Drag, Pinch, Rotate or Tap
62
50
The time of injection can be selected by using I<update> to inject when the
50
The time of injection can be selected by using I<update> to inject when the
63
51
gesture is received or I<finish> to inject when the gesture is finished.
51
gesture is received or I<finish> to inject when the gesture is finished.
64
52
The choice should be written inside the I<when> in the action line.
65
53
        <action name="action1" when="update">
66
54
67
55
The uTouch gesture stack provide gesture updates which can be very small to
68
56
reach the desired interval specified in the trigger.
69
57
To provide more flexibility a gesture accumulation is performed by default to
70
58
the successive property values' updates for a desired gesture until it reaches
71
59
the min-max intervall or the gesture finish, then, the accumlation buffer is
72
60
reinitialized.
73
61
If you want to disable this feature you can specify it explicitly:
74
62
        <trigger prop="delta x" min="-80" max="-40" accumulate="false"/>
75
52
63
76
53
The attributes used in trigger can be obtained by running geistest, you can 
64
The attributes used in trigger can be obtained by running geistest, you can 
77
54
also refer to the list below.
65
also refer to the list below.
78
55
You can use more than one trigger, but you need to use them in the same order
66
You can use more than one trigger, but you need to use them in the same order
79
56
as they appear in the list below.
67
as they appear in the list below.
80
57
68
123
58
Sub-list of general attributes
69
    Sub-list of general attributes
124
59
"device id"       = 13
70
     "device id"       = 13
125
60
"timestamp"       = 180598198
71
     "timestamp"       = 180598198
126
61
"root window id"  = 254
72
     "root window id"  = 254
127
62
"event window id" = 159825921
73
     "event window id" = 159825921
128
63
"child window id" = 159825921
74
     "child window id" = 159825921
129
64
"focus x"         = 0.000000
75
     "focus x"         = 0.000000
130
65
"focus y"         = 0.000000
76
     "focus y"         = 0.000000
131
66
"gesture name"    = "Drag"
77
     "gesture name"    = "Drag"
132
67
"touches"         = 1
78
     "touches"         = 1
133
68
79
      
134
69
Sub-list of attributes used with Drag gesture
80
    Sub-list of attributes used with Drag gesture
135
70
"delta x"    = -8.933333 
81
     "delta x"    = -8.933333 
136
71
"delta y"    = 22.000000
82
     "delta y"    = 22.000000
137
72
"velocity x" = -0.638095
83
     "velocity x" = -0.638095
138
73
"velocity y" = 1.571429
84
     "velocity y" = 1.571429
139
74
"position x" = 634.533386
85
     "position x" = 634.533386
140
75
"position y" = 482.777771
86
     "position y" = 482.777771
141
76
87
142
77
Sub-list of attributes used with Rotate gesture
88
    Sub-list of attributes used with Rotate gesture
143
78
"angle delta"      = -0.358113 
89
     "angle delta"      = -0.358113 
144
79
"angular velocity" = -0.029843
90
     "angular velocity" = -0.029843
145
80
"angle"            = -1.159999
91
     "angle"            = -1.159999
146
81
92
     
147
82
Sub-list of attributes used with Pinch gesture
93
    Sub-list of attributes used with Pinch gesture
148
83
"radius delta"    = -44.935688
94
     "radius delta"    = -44.935688
149
84
"radial velocity" = -3.209692
95
     "radial velocity" = -3.209692
150
85
"radius"          = 180.466690
96
     "radius"          = 180.466690
151
86
97
     
152
87
Sub-list of attributes used with Tap gesture
98
    Sub-list of attributes used with Tap gesture
153
88
"tap time"   = 74.000000 
99
     "tap time"   = 74.000000 
154
89
"position x" = 740.933350
100
     "position x" = 740.933350
155
90
"position y" = 469.333344
101
     "position y" = 469.333344
156
91
102
     
157
92
Last attribues in the general list
103
    Last attribues in the general list
158
93
"boundingbox x1" = 634.533386
104
     "boundingbox x1" = 634.533386
159
94
"boundingbox y1" = 482.777771
105
     "boundingbox y1" = 482.777771
160
95
"boundingbox x2" = 634.533386
106
     "boundingbox x2" = 634.533386
161
96
"boundingbox y2" = 482.777771
107
     "boundingbox y2" = 482.777771
162
97
"touch 0 id"     = 1079.000000
108
     "touch 0 id"     = 1079.000000
163
98
"touch 0 x"      = 634.533386
109
     "touch 0 x"      = 634.533386
164
99
"touch 0 y"      = 482.777771
110
     "touch 0 y"      = 482.777771
165
100
111
166
101
112
167
102
The names of keys list can be obtained after removing the XK_ prefix from
113
The names of keys list can be obtained after removing the XK_ prefix from
168
103
/usr/include/X11/keysymdef.h file
114
/usr/include/X11/keysymdef.h file
169
104
115
180
105
The mouse buttons are written with their corresponding number
116
 The mouse buttons are written with their corresponding number:
181
106
1   Left Button
117
    1   Left Button
182
107
2   Middle Button
118
    2   Middle Button
183
108
3   Right Button
119
    3   Right Button
184
109
4   Wheel Up
120
    4   Wheel Up
185
110
5   Wheel Down
121
    5   Wheel Down
186
111
6   Horizontal Wheel Left
122
    6   Horizontal Wheel Left
187
112
7   Horizontal Wheel Right
123
    7   Horizontal Wheel Right
188
113
8   "Back" in browsers
124
    8   "Back" in browsers
189
114
125
    
190
115
126
191
116
=head1 FILES
127
=head1 FILES
192
117
128
Reviewer	Date Requested	Status
Stephen M. Webb (community)		Approve on 2011-04-27
Chase Douglas (community)	2011-04-27	Approve on 2011-04-27
Review via email: mp+59246@code.launchpad.net