Debian Codegraph @

doc/scripting/lib.scripting.Mouse-class.html

raw
1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6 <title>lib.scripting.Mouse</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9 </head>
10
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <th class="navbar" width="100%"></th>
34 </tr>
35 </table>
36 <table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 Package&nbsp;lib ::
41 <a href="lib.scripting-module.html">Module&nbsp;scripting</a> ::
42 Class&nbsp;Mouse
43 </span>
44 </td>
45 <td>
46 <table cellpadding="0" cellspacing="0">
47 <!-- hide/show private -->
48 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
49 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
50 <tr><td align="right"><span class="options"
51 >[<a href="frames.html" target="_top">frames</a
52 >]&nbsp;|&nbsp;<a href="lib.scripting.Mouse-class.html"
53 target="_top">no&nbsp;frames</a>]</span></td></tr>
54 </table>
55 </td>
56 </tr>
57 </table>
58 <!-- ==================== CLASS DESCRIPTION ==================== -->
59 <h1 class="epydoc">Class Mouse</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#Mouse">source&nbsp;code</a></span></p>
60 <p>Provides access to send mouse clicks</p>
61
62 <!-- ==================== INSTANCE METHODS ==================== -->
63 <a name="section-InstanceMethods"></a>
64 <table class="summary" border="1" cellpadding="3"
65 cellspacing="0" width="100%" bgcolor="white">
66 <tr bgcolor="#70b0f0" class="table-header">
67 <td colspan="2" class="table-header">
68 <table border="0" cellpadding="0" cellspacing="0" width="100%">
69 <tr valign="top">
70 <td align="left"><span class="table-header">Instance Methods</span></td>
71 <td align="right" valign="top"
72 ><span class="options">[<a href="#section-InstanceMethods"
73 class="privatelink" onclick="toggle_private();"
74 >hide private</a>]</span></td>
75 </tr>
76 </table>
77 </td>
78 </tr>
79 <tr>
80 <td width="15%" align="right" valign="top" class="summary">
81 <span class="summary-type">&nbsp;</span>
82 </td><td class="summary">
83 <table width="100%" cellpadding="0" cellspacing="0" border="0">
84 <tr>
85 <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
86 <span class="summary-sig-arg">mediator</span>)</span></td>
87 <td align="right" valign="top">
88 <span class="codelink"><a href="lib.scripting-pysrc.html#Mouse.__init__">source&nbsp;code</a></span>
89
90 </td>
91 </tr>
92 </table>
93
94 </td>
95 </tr>
96 <tr>
97 <td width="15%" align="right" valign="top" class="summary">
98 <span class="summary-type">&nbsp;</span>
99 </td><td class="summary">
100 <table width="100%" cellpadding="0" cellspacing="0" border="0">
101 <tr>
102 <td><span class="summary-sig"><a href="lib.scripting.Mouse-class.html#click_relative" class="summary-sig-name">click_relative</a>(<span class="summary-sig-arg">self</span>,
103 <span class="summary-sig-arg">x</span>,
104 <span class="summary-sig-arg">y</span>,
105 <span class="summary-sig-arg">button</span>)</span><br />
106 Send a mouse click relative to the active window</td>
107 <td align="right" valign="top">
108 <span class="codelink"><a href="lib.scripting-pysrc.html#Mouse.click_relative">source&nbsp;code</a></span>
109
110 </td>
111 </tr>
112 </table>
113
114 </td>
115 </tr>
116 <tr>
117 <td width="15%" align="right" valign="top" class="summary">
118 <span class="summary-type">&nbsp;</span>
119 </td><td class="summary">
120 <table width="100%" cellpadding="0" cellspacing="0" border="0">
121 <tr>
122 <td><span class="summary-sig"><a href="lib.scripting.Mouse-class.html#click_relative_self" class="summary-sig-name">click_relative_self</a>(<span class="summary-sig-arg">self</span>,
123 <span class="summary-sig-arg">x</span>,
124 <span class="summary-sig-arg">y</span>,
125 <span class="summary-sig-arg">button</span>)</span><br />
126 Send a mouse click relative to the current mouse position</td>
127 <td align="right" valign="top">
128 <span class="codelink"><a href="lib.scripting-pysrc.html#Mouse.click_relative_self">source&nbsp;code</a></span>
129
130 </td>
131 </tr>
132 </table>
133
134 </td>
135 </tr>
136 <tr>
137 <td width="15%" align="right" valign="top" class="summary">
138 <span class="summary-type">&nbsp;</span>
139 </td><td class="summary">
140 <table width="100%" cellpadding="0" cellspacing="0" border="0">
141 <tr>
142 <td><span class="summary-sig"><a href="lib.scripting.Mouse-class.html#click_absolute" class="summary-sig-name">click_absolute</a>(<span class="summary-sig-arg">self</span>,
143 <span class="summary-sig-arg">x</span>,
144 <span class="summary-sig-arg">y</span>,
145 <span class="summary-sig-arg">button</span>)</span><br />
146 Send a mouse click relative to the screen (absolute)</td>
147 <td align="right" valign="top">
148 <span class="codelink"><a href="lib.scripting-pysrc.html#Mouse.click_absolute">source&nbsp;code</a></span>
149
150 </td>
151 </tr>
152 </table>
153
154 </td>
155 </tr>
156 <tr>
157 <td width="15%" align="right" valign="top" class="summary">
158 <span class="summary-type">&nbsp;</span>
159 </td><td class="summary">
160 <table width="100%" cellpadding="0" cellspacing="0" border="0">
161 <tr>
162 <td><span class="summary-sig"><a href="lib.scripting.Mouse-class.html#wait_for_click" class="summary-sig-name">wait_for_click</a>(<span class="summary-sig-arg">self</span>,
163 <span class="summary-sig-arg">button</span>,
164 <span class="summary-sig-arg">timeOut</span>=<span class="summary-sig-default">10.0</span>)</span><br />
165 Wait for a mouse click</td>
166 <td align="right" valign="top">
167 <span class="codelink"><a href="lib.scripting-pysrc.html#Mouse.wait_for_click">source&nbsp;code</a></span>
168
169 </td>
170 </tr>
171 </table>
172
173 </td>
174 </tr>
175 </table>
176 <!-- ==================== METHOD DETAILS ==================== -->
177 <a name="section-MethodDetails"></a>
178 <table class="details" border="1" cellpadding="3"
179 cellspacing="0" width="100%" bgcolor="white">
180 <tr bgcolor="#70b0f0" class="table-header">
181 <td colspan="2" class="table-header">
182 <table border="0" cellpadding="0" cellspacing="0" width="100%">
183 <tr valign="top">
184 <td align="left"><span class="table-header">Method Details</span></td>
185 <td align="right" valign="top"
186 ><span class="options">[<a href="#section-MethodDetails"
187 class="privatelink" onclick="toggle_private();"
188 >hide private</a>]</span></td>
189 </tr>
190 </table>
191 </td>
192 </tr>
193 </table>
194 <a name="click_relative"></a>
195 <div>
196 <table class="details" border="1" cellpadding="3"
197 cellspacing="0" width="100%" bgcolor="white">
198 <tr><td>
199 <table width="100%" cellpadding="0" cellspacing="0" border="0">
200 <tr valign="top"><td>
201 <h3 class="epydoc"><span class="sig"><span class="sig-name">click_relative</span>(<span class="sig-arg">self</span>,
202 <span class="sig-arg">x</span>,
203 <span class="sig-arg">y</span>,
204 <span class="sig-arg">button</span>)</span>
205 </h3>
206 </td><td align="right" valign="top"
207 ><span class="codelink"><a href="lib.scripting-pysrc.html#Mouse.click_relative">source&nbsp;code</a></span>&nbsp;
208 </td>
209 </tr></table>
210
211 <p>Send a mouse click relative to the active window</p>
212 <p>Usage: <code>mouse.click_relative(x, y, button)</code></p>
213 <dl class="fields">
214 <dt>Parameters:</dt>
215 <dd><ul class="nomargin-top">
216 <li><strong class="pname"><code>x</code></strong> - x-coordinate in pixels, relative to upper left corner of window</li>
217 <li><strong class="pname"><code>y</code></strong> - y-coordinate in pixels, relative to upper left corner of window</li>
218 <li><strong class="pname"><code>button</code></strong> - mouse button to simulate (left=1, middle=2, right=3)</li>
219 </ul></dd>
220 </dl>
221 </td></tr></table>
222 </div>
223 <a name="click_relative_self"></a>
224 <div>
225 <table class="details" border="1" cellpadding="3"
226 cellspacing="0" width="100%" bgcolor="white">
227 <tr><td>
228 <table width="100%" cellpadding="0" cellspacing="0" border="0">
229 <tr valign="top"><td>
230 <h3 class="epydoc"><span class="sig"><span class="sig-name">click_relative_self</span>(<span class="sig-arg">self</span>,
231 <span class="sig-arg">x</span>,
232 <span class="sig-arg">y</span>,
233 <span class="sig-arg">button</span>)</span>
234 </h3>
235 </td><td align="right" valign="top"
236 ><span class="codelink"><a href="lib.scripting-pysrc.html#Mouse.click_relative_self">source&nbsp;code</a></span>&nbsp;
237 </td>
238 </tr></table>
239
240 <p>Send a mouse click relative to the current mouse position</p>
241 <p>Usage: <code>mouse.click_relative_self(x, y, button)</code></p>
242 <dl class="fields">
243 <dt>Parameters:</dt>
244 <dd><ul class="nomargin-top">
245 <li><strong class="pname"><code>x</code></strong> - x-offset in pixels, relative to current mouse position</li>
246 <li><strong class="pname"><code>y</code></strong> - y-offset in pixels, relative to current mouse position</li>
247 <li><strong class="pname"><code>button</code></strong> - mouse button to simulate (left=1, middle=2, right=3)</li>
248 </ul></dd>
249 </dl>
250 </td></tr></table>
251 </div>
252 <a name="click_absolute"></a>
253 <div>
254 <table class="details" border="1" cellpadding="3"
255 cellspacing="0" width="100%" bgcolor="white">
256 <tr><td>
257 <table width="100%" cellpadding="0" cellspacing="0" border="0">
258 <tr valign="top"><td>
259 <h3 class="epydoc"><span class="sig"><span class="sig-name">click_absolute</span>(<span class="sig-arg">self</span>,
260 <span class="sig-arg">x</span>,
261 <span class="sig-arg">y</span>,
262 <span class="sig-arg">button</span>)</span>
263 </h3>
264 </td><td align="right" valign="top"
265 ><span class="codelink"><a href="lib.scripting-pysrc.html#Mouse.click_absolute">source&nbsp;code</a></span>&nbsp;
266 </td>
267 </tr></table>
268
269 <p>Send a mouse click relative to the screen (absolute)</p>
270 <p>Usage: <code>mouse.click_absolute(x, y, button)</code></p>
271 <dl class="fields">
272 <dt>Parameters:</dt>
273 <dd><ul class="nomargin-top">
274 <li><strong class="pname"><code>x</code></strong> - x-coordinate in pixels, relative to upper left corner of window</li>
275 <li><strong class="pname"><code>y</code></strong> - y-coordinate in pixels, relative to upper left corner of window</li>
276 <li><strong class="pname"><code>button</code></strong> - mouse button to simulate (left=1, middle=2, right=3)</li>
277 </ul></dd>
278 </dl>
279 </td></tr></table>
280 </div>
281 <a name="wait_for_click"></a>
282 <div>
283 <table class="details" border="1" cellpadding="3"
284 cellspacing="0" width="100%" bgcolor="white">
285 <tr><td>
286 <table width="100%" cellpadding="0" cellspacing="0" border="0">
287 <tr valign="top"><td>
288 <h3 class="epydoc"><span class="sig"><span class="sig-name">wait_for_click</span>(<span class="sig-arg">self</span>,
289 <span class="sig-arg">button</span>,
290 <span class="sig-arg">timeOut</span>=<span class="sig-default">10.0</span>)</span>
291 </h3>
292 </td><td align="right" valign="top"
293 ><span class="codelink"><a href="lib.scripting-pysrc.html#Mouse.wait_for_click">source&nbsp;code</a></span>&nbsp;
294 </td>
295 </tr></table>
296
297 <p>Wait for a mouse click</p>
298 <p>Usage: <code>mouse.wait_for_click(self, button,
299 timeOut=10.0)</code></p>
300 <dl class="fields">
301 <dt>Parameters:</dt>
302 <dd><ul class="nomargin-top">
303 <li><strong class="pname"><code>button</code></strong> - they mouse button click to wait for as a button number, 1-9</li>
304 <li><strong class="pname"><code>timeOut</code></strong> - maximum time, in seconds, to wait for the keypress to occur</li>
305 </ul></dd>
306 </dl>
307 </td></tr></table>
308 </div>
309 <br />
310 <!-- ==================== NAVIGATION BAR ==================== -->
311 <table class="navbar" border="0" width="100%" cellpadding="0"
312 bgcolor="#a0c0ff" cellspacing="0">
313 <tr valign="middle">
314 <!-- Home link -->
315 <th>&nbsp;&nbsp;&nbsp;<a
316 href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
317
318 <!-- Tree link -->
319 <th>&nbsp;&nbsp;&nbsp;<a
320 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
321
322 <!-- Index link -->
323 <th>&nbsp;&nbsp;&nbsp;<a
324 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
325
326 <!-- Help link -->
327 <th>&nbsp;&nbsp;&nbsp;<a
328 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
329
330 <th class="navbar" width="100%"></th>
331 </tr>
332 </table>
333 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
334 <tr>
335 <td align="left" class="footer">
336 Generated by Epydoc 3.0.1 on Fri Apr 20 20:26:25 2012
337 </td>
338 <td align="right" class="footer">
339 <a target="mainFrame" href="http://epydoc.sourceforge.net"
340 >http://epydoc.sourceforge.net</a>
341 </td>
342 </tr>
343 </table>
344
345 <script type="text/javascript">
346 <!--
347 // Private objects are initially displayed (because if
348 // javascript is turned off then we want them to be
349 // visible); but by default, we want to hide them. So hide
350 // them unless we have a cookie that says to show them.
351 checkCookie();
352 // -->
353 </script>
354 </body>
355 </html>