~ubuntu-branches/ubuntu/quantal/ginn/quantal

« back to all changes in this revision

Viewing changes to .pc/document_accumalate_property.patch/src/ginn.pod

  • Committer: Package Import Robot
  • Author(s): Vibhav Pant
  • Date: 2012-06-15 11:51:49 UTC
  • Revision ID: package-import@ubuntu.com-20120615115149-4m7rgcqrenz5rprk
Tags: 0.2.4-0ubuntu2
* debian/patches/document_accumalate_property.patch
  - Documents the Accumulate Option in the Wishes file (LP: #769959)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
=encoding utf8
 
2
 
 
3
=head1 NAME
 
4
 
 
5
ginn - Gesture to Keypress / Mouse Button injector
 
6
 
 
7
=head1 SYNOPSIS
 
8
 
 
9
ginn [<specific configuration file>]
 
10
 
 
11
=head1 DESCRIPTION
 
12
 
 
13
B<ginn> is a program to test support gestures in legacy applications without the
 
14
need to rewrite them.  This support is made by injecting keypresses or mouse
 
15
buttons after matching rules from wishes.xml file.
 
16
 
 
17
You can define the matching rules by expressing I<wishes>. Each wish contains
 
18
the name of the gesture, number of fingers, the matching rules.
 
19
The keypress to inject is defined by I<key> tag, and the mouse button by
 
20
I<button>, you can add also up to 4 modifiers keys like I<Control_L>.
 
21
 
 
22
 
 
23
=head1 EXAMPLES
 
24
 
 
25
Sample wishes file
 
26
 
 
27
= <ginn>
 
28
=   <global>
 
29
=     <wish gesture="Drag" fingers="2">
 
30
=       <action name="action5" when="update">
 
31
=         <trigger prop="delta y" min="20" max="80"/>
 
32
=         <key>Down</key>
 
33
=       </action>
 
34
=     </wish>
 
35
=   </global>
 
36
=   <applications>
 
37
=     <application name="inkscape">
 
38
=     <wish gesture="Pinch" fingers="2">
 
39
=       <action name="action1" when="update">
 
40
=         <trigger prop="radius delta" min="-200" max="-40"/>
 
41
=         <key>KP_Subtract</key>
 
42
=       </action>
 
43
=     </wish>
 
44
=     </application>
 
45
=   </applications>
 
46
= </ginn>
 
47
 
 
48
 
 
49
Gesture type can be : Drag, Pinch, Rotate or Tap
 
50
The time of injection can be selected by using I<update> to inject when the
 
51
gesture is received or I<finish> to inject when the gesture is finished.
 
52
 
 
53
The attributes used in trigger can be obtained by running geistest, you can 
 
54
also refer to the list below.
 
55
You can use more than one trigger, but you need to use them in the same order
 
56
as they appear in the list below.
 
57
 
 
58
Sub-list of general attributes
 
59
"device id"       = 13
 
60
"timestamp"       = 180598198
 
61
"root window id"  = 254
 
62
"event window id" = 159825921
 
63
"child window id" = 159825921
 
64
"focus x"         = 0.000000
 
65
"focus y"         = 0.000000
 
66
"gesture name"    = "Drag"
 
67
"touches"         = 1
 
68
 
 
69
Sub-list of attributes used with Drag gesture
 
70
"delta x"    = -8.933333 
 
71
"delta y"    = 22.000000
 
72
"velocity x" = -0.638095
 
73
"velocity y" = 1.571429
 
74
"position x" = 634.533386
 
75
"position y" = 482.777771
 
76
 
 
77
Sub-list of attributes used with Rotate gesture
 
78
"angle delta"      = -0.358113 
 
79
"angular velocity" = -0.029843
 
80
"angle"            = -1.159999
 
81
 
 
82
Sub-list of attributes used with Pinch gesture
 
83
"radius delta"    = -44.935688
 
84
"radial velocity" = -3.209692
 
85
"radius"          = 180.466690
 
86
 
 
87
Sub-list of attributes used with Tap gesture
 
88
"tap time"   = 74.000000 
 
89
"position x" = 740.933350
 
90
"position y" = 469.333344
 
91
 
 
92
Last attribues in the general list
 
93
"boundingbox x1" = 634.533386
 
94
"boundingbox y1" = 482.777771
 
95
"boundingbox x2" = 634.533386
 
96
"boundingbox y2" = 482.777771
 
97
"touch 0 id"     = 1079.000000
 
98
"touch 0 x"      = 634.533386
 
99
"touch 0 y"      = 482.777771
 
100
 
 
101
 
 
102
The names of keys list can be obtained after removing the XK_ prefix from
 
103
/usr/include/X11/keysymdef.h file
 
104
 
 
105
The mouse buttons are written with their corresponding number
 
106
1   Left Button
 
107
2   Middle Button
 
108
3   Right Button
 
109
4   Wheel Up
 
110
5   Wheel Down
 
111
6   Horizontal Wheel Left
 
112
7   Horizontal Wheel Right
 
113
8   "Back" in browsers
 
114
 
 
115
 
 
116
=head1 FILES
 
117
 
 
118
I</etc/ginn/wishes.xml>
 
119
User customized wishes file.
 
120
 
 
121
I</usr/share/ginn/wishes.xml>
 
122
Basic ginn wishes file installed for reference.
 
123
 
 
124
=head1 SEE ALSO
 
125
 
 
126
geistest
 
127
 
 
128
=head1 AUTHOR
 
129
 
 
130
Mohamed Ikbel Boulabiar <boulabiar@gmail.com>
 
131
 
 
132
=head1 COPYRIGHT
 
133
 
 
134
Copyright 2010-2011 by Canonical, Ltd.
 
135