Merge lp:~boulabiar/ginn/lp-769959 into lp:ginn

Proposed by Mohamed IKBEL Boulabiar on 2011-04-27
Status: Merged
Merged at revision: 86
Proposed branch: lp:~boulabiar/ginn/lp-769959
Merge into: lp:ginn
Diff against target: 191 lines (+90/-79)
1 file modified
src/ginn.pod (+90/-79)
To merge this branch: bzr merge lp:~boulabiar/ginn/lp-769959
Reviewer Review Type 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

Description of the change

This branch fixes the bug #769959 and document the accumulate option in the wishes file.
It also fixes man file styling issues in the "Example" part.

To post a comment you must log in.
Chase Douglas (chasedouglas) wrote :

I don't see anything wrong with the changes, so they're fine by me :).

review: Approve
Stephen M. Webb (bregma) wrote :

Mmmm, documentation. Never enough.

review: Approve

Preview Diff

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