← Back to branch summary

~ubuntu-branches/ubuntu/lucid/autokey/lucid

« back to all changes in this revision

Viewing changes to doc/lib.scripting.Keyboard-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Luke Faraone
  • Date: 2009-09-27 15:08:28 UTC
  • mfrom: (1.1.2 upstream) (2.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090927150828-6sded0d8od2mqsvp
Tags: 0.60.5-1
http://bugs.debian.org/548531
* New upstream version (closes: 548531)
  * Change to using pickle instead of cPickle due to a bug in the latter 
  * Bring in changes to common modules needed for GTK version
  * Fix design flaw in pickle error trapping code
  * Fix <enter> not being sent at the end of unicode char entry
  * Fix service crashing when undoing an expansion with backspace
  * Use Phrase instead of Script in some nogui functions

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/lib.scripting.Keyboard-class.html
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>&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;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&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.Keyboard-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 Keyboard</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard">source&nbsp;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">&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#Keyboard.__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.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&nbsp;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">&nbsp;</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&nbsp;code</a></span>
126
 
            
127
 
          </td>
128
 
        </tr>
129
 
      </table>
130
 
      
131
 
    </td>
132
 
  </tr>
133
 
</table>
134
 
<!-- ==================== METHOD DETAILS ==================== -->
135
 
<a name="section-MethodDetails"></a>
136
 
<table class="details" border="1" cellpadding="3"
137
 
       cellspacing="0" width="100%" bgcolor="white">
138
 
<tr bgcolor="#70b0f0" class="table-header">
139
 
  <td colspan="2" class="table-header">
140
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
141
 
      <tr valign="top">
142
 
        <td align="left"><span class="table-header">Method Details</span></td>
143
 
        <td align="right" valign="top"
144
 
         ><span class="options">[<a href="#section-MethodDetails"
145
 
         class="privatelink" onclick="toggle_private();"
146
 
         >hide private</a>]</span></td>
147
 
      </tr>
148
 
    </table>
149
 
  </td>
150
 
</tr>
151
 
</table>
152
 
<a name="send_keys"></a>
153
 
<div>
154
 
<table class="details" border="1" cellpadding="3"
155
 
       cellspacing="0" width="100%" bgcolor="white">
156
 
<tr><td>
157
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
158
 
  <tr valign="top"><td>
159
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">send_keys</span>(<span class="sig-arg">self</span>,
160
 
        <span class="sig-arg">keyString</span>)</span>
161
 
  </h3>
162
 
  </td><td align="right" valign="top"
163
 
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.send_keys">source&nbsp;code</a></span>&nbsp;
164
 
    </td>
165
 
  </tr></table>
166
 
  
167
 
  <p>Send a sequence of keys via keyboard events</p>
168
 
  <p>Usage: <code>keyboard.send_keys(keyString)</code></p>
169
 
  <dl class="fields">
170
 
    <dt>Parameters:</dt>
171
 
    <dd><ul class="nomargin-top">
172
 
        <li><strong class="pname"><code>keyString</code></strong> - string of keys (including special keys) to send</li>
173
 
    </ul></dd>
174
 
  </dl>
175
 
</td></tr></table>
176
 
</div>
177
 
<a name="send_key"></a>
178
 
<div>
179
 
<table class="details" border="1" cellpadding="3"
180
 
       cellspacing="0" width="100%" bgcolor="white">
181
 
<tr><td>
182
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
183
 
  <tr valign="top"><td>
184
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">send_key</span>(<span class="sig-arg">self</span>,
185
 
        <span class="sig-arg">key</span>,
186
 
        <span class="sig-arg">repeat</span>=<span class="sig-default">1</span>)</span>
187
 
  </h3>
188
 
  </td><td align="right" valign="top"
189
 
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Keyboard.send_key">source&nbsp;code</a></span>&nbsp;
190
 
    </td>
191
 
  </tr></table>
192
 
  
193
 
  <p>Send a keyboard event</p>
194
 
  <p>Usage: <code>keyboard.send_key(key, repeat=1)</code></p>
195
 
  <dl class="fields">
196
 
    <dt>Parameters:</dt>
197
 
    <dd><ul class="nomargin-top">
198
 
        <li><strong class="pname"><code>key</code></strong> - they key to be sent (e.g. &quot;s&quot; or 
199
 
          &quot;&lt;enter&gt;&quot;)</li>
200
 
        <li><strong class="pname"><code>repeat</code></strong> - number of times to repeat the key event</li>
201
 
    </ul></dd>
202
 
  </dl>
203
 
</td></tr></table>
204
 
</div>
205
 
<br />
206
 
<!-- ==================== NAVIGATION BAR ==================== -->
207
 
<table class="navbar" border="0" width="100%" cellpadding="0"
208
 
       bgcolor="#a0c0ff" cellspacing="0">
209
 
  <tr valign="middle">
210
 
  <!-- Home link -->
211
 
      <th>&nbsp;&nbsp;&nbsp;<a
212
 
        href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
213
 
 
214
 
  <!-- Tree link -->
215
 
      <th>&nbsp;&nbsp;&nbsp;<a
216
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
217
 
 
218
 
  <!-- Index link -->
219
 
      <th>&nbsp;&nbsp;&nbsp;<a
220
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
221
 
 
222
 
  <!-- Help link -->
223
 
      <th>&nbsp;&nbsp;&nbsp;<a
224
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
225
 
 
226
 
      <th class="navbar" width="100%"></th>
227
 
  </tr>
228
 
</table>
229
 
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
230
 
  <tr>
231
 
    <td align="left" class="footer">
232
 
    Generated by Epydoc 3.0.1 on Thu Aug 13 13:17:08 2009
233
 
    </td>
234
 
    <td align="right" class="footer">
235
 
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
236
 
        >http://epydoc.sourceforge.net</a>
237
 
    </td>
238
 
  </tr>
239
 
</table>
240
 
 
241
 
<script type="text/javascript">
242
 
  <!--
243
 
  // Private objects are initially displayed (because if
244
 
  // javascript is turned off then we want them to be
245
 
  // visible); but by default, we want to hide them.  So hide
246
 
  // them unless we have a cookie that says to show them.
247
 
  checkCookie();
248
 
  // -->
249
 
</script>
250
 
</body>
251
 
</html>