| 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.Keyboard</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> <a |
| 19 |
href="lib.scripting-module.html">Home</a> </th> |
| 20 |
|
| 21 |
<!-- Tree link --> |
| 22 |
<th> <a |
| 23 |
href="module-tree.html">Trees</a> </th> |
| 24 |
|
| 25 |
<!-- Index link --> |
| 26 |
<th> <a |
| 27 |
href="identifier-index.html">Indices</a> </th> |
| 28 |
|
| 29 |
<!-- Help link --> |
| 30 |
<th> <a |
| 31 |
href="help.html">Help</a> </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 lib :: |
| 41 |
<a href="lib.scripting-module.html">Module scripting</a> :: |
| 42 |
Class Keyboard |
| 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 private</a>]</span></td></tr> |
| 50 |
<tr><td align="right"><span class="options" |
| 51 |
>[<a href="frames.html" target="_top">frames</a |
| 52 |
>] | <a href="lib.scripting.Keyboard-class.html" |
| 53 |
target="_top">no frames</a>]</span></td></tr> |
| 54 |
</table> |
| 55 |
</td> |
| 56 |
</tr> |
| 57 |
</table> |
| 58 |
<!-- ==================== CLASS DESCRIPTION ==================== --> |
| 59 |
<h1 class="epydoc">Class Keyboard</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard">source code</a></span></p> |
| 60 |
<p>Provides access to the keyboard for event generation.</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"> </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#Keyboard.__init__">source 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"> </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.Keyboard-class.html#send_keys" class="summary-sig-name">send_keys</a>(<span class="summary-sig-arg">self</span>, |
| 103 |
<span class="summary-sig-arg">keyString</span>)</span><br /> |
| 104 |
Send a sequence of keys via keyboard events</td> |
| 105 |
<td align="right" valign="top"> |
| 106 |
<span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.send_keys">source code</a></span> |
| 107 |
|
| 108 |
</td> |
| 109 |
</tr> |
| 110 |
</table> |
| 111 |
|
| 112 |
</td> |
| 113 |
</tr> |
| 114 |
<tr> |
| 115 |
<td width="15%" align="right" valign="top" class="summary"> |
| 116 |
<span class="summary-type"> </span> |
| 117 |
</td><td class="summary"> |
| 118 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 119 |
<tr> |
| 120 |
<td><span class="summary-sig"><a href="lib.scripting.Keyboard-class.html#send_key" class="summary-sig-name">send_key</a>(<span class="summary-sig-arg">self</span>, |
| 121 |
<span class="summary-sig-arg">key</span>, |
| 122 |
<span class="summary-sig-arg">repeat</span>=<span class="summary-sig-default">1</span>)</span><br /> |
| 123 |
Send a keyboard event</td> |
| 124 |
<td align="right" valign="top"> |
| 125 |
<span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.send_key">source code</a></span> |
| 126 |
|
| 127 |
</td> |
| 128 |
</tr> |
| 129 |
</table> |
| 130 |
|
| 131 |
</td> |
| 132 |
</tr> |
| 133 |
<tr> |
| 134 |
<td width="15%" align="right" valign="top" class="summary"> |
| 135 |
<span class="summary-type"> </span> |
| 136 |
</td><td class="summary"> |
| 137 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 138 |
<tr> |
| 139 |
<td><span class="summary-sig"><a href="lib.scripting.Keyboard-class.html#press_key" class="summary-sig-name">press_key</a>(<span class="summary-sig-arg">self</span>, |
| 140 |
<span class="summary-sig-arg">key</span>)</span><br /> |
| 141 |
Send a key down event</td> |
| 142 |
<td align="right" valign="top"> |
| 143 |
<span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.press_key">source code</a></span> |
| 144 |
|
| 145 |
</td> |
| 146 |
</tr> |
| 147 |
</table> |
| 148 |
|
| 149 |
</td> |
| 150 |
</tr> |
| 151 |
<tr> |
| 152 |
<td width="15%" align="right" valign="top" class="summary"> |
| 153 |
<span class="summary-type"> </span> |
| 154 |
</td><td class="summary"> |
| 155 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 156 |
<tr> |
| 157 |
<td><span class="summary-sig"><a href="lib.scripting.Keyboard-class.html#release_key" class="summary-sig-name">release_key</a>(<span class="summary-sig-arg">self</span>, |
| 158 |
<span class="summary-sig-arg">key</span>)</span><br /> |
| 159 |
Send a key up event</td> |
| 160 |
<td align="right" valign="top"> |
| 161 |
<span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.release_key">source code</a></span> |
| 162 |
|
| 163 |
</td> |
| 164 |
</tr> |
| 165 |
</table> |
| 166 |
|
| 167 |
</td> |
| 168 |
</tr> |
| 169 |
<tr> |
| 170 |
<td width="15%" align="right" valign="top" class="summary"> |
| 171 |
<span class="summary-type"> </span> |
| 172 |
</td><td class="summary"> |
| 173 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 174 |
<tr> |
| 175 |
<td><span class="summary-sig"><a href="lib.scripting.Keyboard-class.html#fake_keypress" class="summary-sig-name">fake_keypress</a>(<span class="summary-sig-arg">self</span>, |
| 176 |
<span class="summary-sig-arg">key</span>, |
| 177 |
<span class="summary-sig-arg">repeat</span>=<span class="summary-sig-default">1</span>)</span><br /> |
| 178 |
Fake a keypress</td> |
| 179 |
<td align="right" valign="top"> |
| 180 |
<span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.fake_keypress">source code</a></span> |
| 181 |
|
| 182 |
</td> |
| 183 |
</tr> |
| 184 |
</table> |
| 185 |
|
| 186 |
</td> |
| 187 |
</tr> |
| 188 |
<tr> |
| 189 |
<td width="15%" align="right" valign="top" class="summary"> |
| 190 |
<span class="summary-type"> </span> |
| 191 |
</td><td class="summary"> |
| 192 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 193 |
<tr> |
| 194 |
<td><span class="summary-sig"><a href="lib.scripting.Keyboard-class.html#wait_for_keypress" class="summary-sig-name">wait_for_keypress</a>(<span class="summary-sig-arg">self</span>, |
| 195 |
<span class="summary-sig-arg">key</span>, |
| 196 |
<span class="summary-sig-arg">modifiers</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>, |
| 197 |
<span class="summary-sig-arg">timeOut</span>=<span class="summary-sig-default">10.0</span>)</span><br /> |
| 198 |
Wait for a keypress or key combination</td> |
| 199 |
<td align="right" valign="top"> |
| 200 |
<span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.wait_for_keypress">source code</a></span> |
| 201 |
|
| 202 |
</td> |
| 203 |
</tr> |
| 204 |
</table> |
| 205 |
|
| 206 |
</td> |
| 207 |
</tr> |
| 208 |
</table> |
| 209 |
<!-- ==================== METHOD DETAILS ==================== --> |
| 210 |
<a name="section-MethodDetails"></a> |
| 211 |
<table class="details" border="1" cellpadding="3" |
| 212 |
cellspacing="0" width="100%" bgcolor="white"> |
| 213 |
<tr bgcolor="#70b0f0" class="table-header"> |
| 214 |
<td colspan="2" class="table-header"> |
| 215 |
<table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 216 |
<tr valign="top"> |
| 217 |
<td align="left"><span class="table-header">Method Details</span></td> |
| 218 |
<td align="right" valign="top" |
| 219 |
><span class="options">[<a href="#section-MethodDetails" |
| 220 |
class="privatelink" onclick="toggle_private();" |
| 221 |
>hide private</a>]</span></td> |
| 222 |
</tr> |
| 223 |
</table> |
| 224 |
</td> |
| 225 |
</tr> |
| 226 |
</table> |
| 227 |
<a name="send_keys"></a> |
| 228 |
<div> |
| 229 |
<table class="details" border="1" cellpadding="3" |
| 230 |
cellspacing="0" width="100%" bgcolor="white"> |
| 231 |
<tr><td> |
| 232 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 233 |
<tr valign="top"><td> |
| 234 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">send_keys</span>(<span class="sig-arg">self</span>, |
| 235 |
<span class="sig-arg">keyString</span>)</span> |
| 236 |
</h3> |
| 237 |
</td><td align="right" valign="top" |
| 238 |
><span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.send_keys">source code</a></span> |
| 239 |
</td> |
| 240 |
</tr></table> |
| 241 |
|
| 242 |
<p>Send a sequence of keys via keyboard events</p> |
| 243 |
<p>Usage: <code>keyboard.send_keys(keyString)</code></p> |
| 244 |
<dl class="fields"> |
| 245 |
<dt>Parameters:</dt> |
| 246 |
<dd><ul class="nomargin-top"> |
| 247 |
<li><strong class="pname"><code>keyString</code></strong> - string of keys (including special keys) to send</li> |
| 248 |
</ul></dd> |
| 249 |
</dl> |
| 250 |
</td></tr></table> |
| 251 |
</div> |
| 252 |
<a name="send_key"></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">send_key</span>(<span class="sig-arg">self</span>, |
| 260 |
<span class="sig-arg">key</span>, |
| 261 |
<span class="sig-arg">repeat</span>=<span class="sig-default">1</span>)</span> |
| 262 |
</h3> |
| 263 |
</td><td align="right" valign="top" |
| 264 |
><span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.send_key">source code</a></span> |
| 265 |
</td> |
| 266 |
</tr></table> |
| 267 |
|
| 268 |
<p>Send a keyboard event</p> |
| 269 |
<p>Usage: <code>keyboard.send_key(key, repeat=1)</code></p> |
| 270 |
<dl class="fields"> |
| 271 |
<dt>Parameters:</dt> |
| 272 |
<dd><ul class="nomargin-top"> |
| 273 |
<li><strong class="pname"><code>key</code></strong> - they key to be sent (e.g. "s" or |
| 274 |
"<enter>")</li> |
| 275 |
<li><strong class="pname"><code>repeat</code></strong> - number of times to repeat the key event</li> |
| 276 |
</ul></dd> |
| 277 |
</dl> |
| 278 |
</td></tr></table> |
| 279 |
</div> |
| 280 |
<a name="press_key"></a> |
| 281 |
<div> |
| 282 |
<table class="details" border="1" cellpadding="3" |
| 283 |
cellspacing="0" width="100%" bgcolor="white"> |
| 284 |
<tr><td> |
| 285 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 286 |
<tr valign="top"><td> |
| 287 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">press_key</span>(<span class="sig-arg">self</span>, |
| 288 |
<span class="sig-arg">key</span>)</span> |
| 289 |
</h3> |
| 290 |
</td><td align="right" valign="top" |
| 291 |
><span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.press_key">source code</a></span> |
| 292 |
</td> |
| 293 |
</tr></table> |
| 294 |
|
| 295 |
<p>Send a key down event</p> |
| 296 |
<p>Usage: <code>keyboard.press_key(key)</code></p> |
| 297 |
<p>The key will be treated as down until a matching release_key() is |
| 298 |
sent.</p> |
| 299 |
<dl class="fields"> |
| 300 |
<dt>Parameters:</dt> |
| 301 |
<dd><ul class="nomargin-top"> |
| 302 |
<li><strong class="pname"><code>key</code></strong> - they key to be pressed (e.g. "s" or |
| 303 |
"<enter>")</li> |
| 304 |
</ul></dd> |
| 305 |
</dl> |
| 306 |
</td></tr></table> |
| 307 |
</div> |
| 308 |
<a name="release_key"></a> |
| 309 |
<div> |
| 310 |
<table class="details" border="1" cellpadding="3" |
| 311 |
cellspacing="0" width="100%" bgcolor="white"> |
| 312 |
<tr><td> |
| 313 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 314 |
<tr valign="top"><td> |
| 315 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">release_key</span>(<span class="sig-arg">self</span>, |
| 316 |
<span class="sig-arg">key</span>)</span> |
| 317 |
</h3> |
| 318 |
</td><td align="right" valign="top" |
| 319 |
><span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.release_key">source code</a></span> |
| 320 |
</td> |
| 321 |
</tr></table> |
| 322 |
|
| 323 |
<p>Send a key up event</p> |
| 324 |
<p>Usage: <code>keyboard.release_key(key)</code></p> |
| 325 |
<p>If the specified key was not made down using press_key(), the event |
| 326 |
will be ignored.</p> |
| 327 |
<dl class="fields"> |
| 328 |
<dt>Parameters:</dt> |
| 329 |
<dd><ul class="nomargin-top"> |
| 330 |
<li><strong class="pname"><code>key</code></strong> - they key to be released (e.g. "s" or |
| 331 |
"<enter>")</li> |
| 332 |
</ul></dd> |
| 333 |
</dl> |
| 334 |
</td></tr></table> |
| 335 |
</div> |
| 336 |
<a name="fake_keypress"></a> |
| 337 |
<div> |
| 338 |
<table class="details" border="1" cellpadding="3" |
| 339 |
cellspacing="0" width="100%" bgcolor="white"> |
| 340 |
<tr><td> |
| 341 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 342 |
<tr valign="top"><td> |
| 343 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">fake_keypress</span>(<span class="sig-arg">self</span>, |
| 344 |
<span class="sig-arg">key</span>, |
| 345 |
<span class="sig-arg">repeat</span>=<span class="sig-default">1</span>)</span> |
| 346 |
</h3> |
| 347 |
</td><td align="right" valign="top" |
| 348 |
><span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.fake_keypress">source code</a></span> |
| 349 |
</td> |
| 350 |
</tr></table> |
| 351 |
|
| 352 |
<p>Fake a keypress</p> |
| 353 |
<p>Usage: <code>keyboard.fake_keypress(key, repeat=1)</code></p> |
| 354 |
<p>Uses XTest to 'fake' a keypress. This is useful to send keypresses to |
| 355 |
some applications which won't respond to keyboard.send_key()</p> |
| 356 |
<dl class="fields"> |
| 357 |
<dt>Parameters:</dt> |
| 358 |
<dd><ul class="nomargin-top"> |
| 359 |
<li><strong class="pname"><code>key</code></strong> - they key to be sent (e.g. "s" or |
| 360 |
"<enter>")</li> |
| 361 |
<li><strong class="pname"><code>repeat</code></strong> - number of times to repeat the key event</li> |
| 362 |
</ul></dd> |
| 363 |
</dl> |
| 364 |
</td></tr></table> |
| 365 |
</div> |
| 366 |
<a name="wait_for_keypress"></a> |
| 367 |
<div> |
| 368 |
<table class="details" border="1" cellpadding="3" |
| 369 |
cellspacing="0" width="100%" bgcolor="white"> |
| 370 |
<tr><td> |
| 371 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 372 |
<tr valign="top"><td> |
| 373 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">wait_for_keypress</span>(<span class="sig-arg">self</span>, |
| 374 |
<span class="sig-arg">key</span>, |
| 375 |
<span class="sig-arg">modifiers</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>, |
| 376 |
<span class="sig-arg">timeOut</span>=<span class="sig-default">10.0</span>)</span> |
| 377 |
</h3> |
| 378 |
</td><td align="right" valign="top" |
| 379 |
><span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.wait_for_keypress">source code</a></span> |
| 380 |
</td> |
| 381 |
</tr></table> |
| 382 |
|
| 383 |
<p>Wait for a keypress or key combination</p> |
| 384 |
<p>Usage: <code>keyboard.wait_for_keypress(self, key, modifiers=[], |
| 385 |
timeOut=10.0)</code></p> |
| 386 |
<p>Note: this function cannot be used to wait for modifier keys on their |
| 387 |
own</p> |
| 388 |
<dl class="fields"> |
| 389 |
<dt>Parameters:</dt> |
| 390 |
<dd><ul class="nomargin-top"> |
| 391 |
<li><strong class="pname"><code>key</code></strong> - they key to wait for</li> |
| 392 |
<li><strong class="pname"><code>modifiers</code></strong> - list of modifiers that should be pressed with the key</li> |
| 393 |
<li><strong class="pname"><code>timeOut</code></strong> - maximum time, in seconds, to wait for the keypress to occur</li> |
| 394 |
</ul></dd> |
| 395 |
</dl> |
| 396 |
</td></tr></table> |
| 397 |
</div> |
| 398 |
<br /> |
| 399 |
<!-- ==================== NAVIGATION BAR ==================== --> |
| 400 |
<table class="navbar" border="0" width="100%" cellpadding="0" |
| 401 |
bgcolor="#a0c0ff" cellspacing="0"> |
| 402 |
<tr valign="middle"> |
| 403 |
<!-- Home link --> |
| 404 |
<th> <a |
| 405 |
href="lib.scripting-module.html">Home</a> </th> |
| 406 |
|
| 407 |
<!-- Tree link --> |
| 408 |
<th> <a |
| 409 |
href="module-tree.html">Trees</a> </th> |
| 410 |
|
| 411 |
<!-- Index link --> |
| 412 |
<th> <a |
| 413 |
href="identifier-index.html">Indices</a> </th> |
| 414 |
|
| 415 |
<!-- Help link --> |
| 416 |
<th> <a |
| 417 |
href="help.html">Help</a> </th> |
| 418 |
|
| 419 |
<th class="navbar" width="100%"></th> |
| 420 |
</tr> |
| 421 |
</table> |
| 422 |
<table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 423 |
<tr> |
| 424 |
<td align="left" class="footer"> |
| 425 |
Generated by Epydoc 3.0.1 on Fri Apr 20 20:26:25 2012 |
| 426 |
</td> |
| 427 |
<td align="right" class="footer"> |
| 428 |
<a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 429 |
>http://epydoc.sourceforge.net</a> |
| 430 |
</td> |
| 431 |
</tr> |
| 432 |
</table> |
| 433 |
|
| 434 |
<script type="text/javascript"> |
| 435 |
<!-- |
| 436 |
// Private objects are initially displayed (because if |
| 437 |
// javascript is turned off then we want them to be |
| 438 |
// visible); but by default, we want to hide them. So hide |
| 439 |
// them unless we have a cookie that says to show them. |
| 440 |
checkCookie(); |
| 441 |
// --> |
| 442 |
</script> |
| 443 |
</body> |
| 444 |
</html> |