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

« back to all changes in this revision

Viewing changes to doc/scripting/lib.scripting.Clipboard-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
* 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:
 
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.Clipboard</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;Clipboard
 
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.Clipboard-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 Clipboard</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard">source&nbsp;code</a></span></p>
 
60
<p>Read/write access to the X selection and clipboard</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">app</span>)</span></td>
 
87
          <td align="right" valign="top">
 
88
            <span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.__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.Clipboard-class.html#fill_selection" class="summary-sig-name">fill_selection</a>(<span class="summary-sig-arg">self</span>,
 
103
        <span class="summary-sig-arg">contents</span>)</span><br />
 
104
      Copy text into the X selection</td>
 
105
          <td align="right" valign="top">
 
106
            <span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.fill_selection">source&nbsp;code</a></span>
 
107
            
 
108
          </td>
 
109
        </tr>
 
110
      </table>
 
111
      
 
112
    </td>
 
113
  </tr>
 
114
<tr class="private">
 
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 name="__fillSelection"></a><span class="summary-sig-name">__fillSelection</span>(<span class="summary-sig-arg">self</span>,
 
121
        <span class="summary-sig-arg">string</span>)</span></td>
 
122
          <td align="right" valign="top">
 
123
            <span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.__fillSelection">source&nbsp;code</a></span>
 
124
            
 
125
          </td>
 
126
        </tr>
 
127
      </table>
 
128
      
 
129
    </td>
 
130
  </tr>
 
131
<tr>
 
132
    <td width="15%" align="right" valign="top" class="summary">
 
133
      <span class="summary-type">&nbsp;</span>
 
134
    </td><td class="summary">
 
135
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
136
        <tr>
 
137
          <td><span class="summary-sig"><a href="lib.scripting.Clipboard-class.html#get_selection" class="summary-sig-name">get_selection</a>(<span class="summary-sig-arg">self</span>)</span><br />
 
138
      Read text from the X selection</td>
 
139
          <td align="right" valign="top">
 
140
            <span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.get_selection">source&nbsp;code</a></span>
 
141
            
 
142
          </td>
 
143
        </tr>
 
144
      </table>
 
145
      
 
146
    </td>
 
147
  </tr>
 
148
<tr class="private">
 
149
    <td width="15%" align="right" valign="top" class="summary">
 
150
      <span class="summary-type">&nbsp;</span>
 
151
    </td><td class="summary">
 
152
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
153
        <tr>
 
154
          <td><span class="summary-sig"><a name="__getSelection"></a><span class="summary-sig-name">__getSelection</span>(<span class="summary-sig-arg">self</span>)</span></td>
 
155
          <td align="right" valign="top">
 
156
            <span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.__getSelection">source&nbsp;code</a></span>
 
157
            
 
158
          </td>
 
159
        </tr>
 
160
      </table>
 
161
      
 
162
    </td>
 
163
  </tr>
 
164
<tr>
 
165
    <td width="15%" align="right" valign="top" class="summary">
 
166
      <span class="summary-type">&nbsp;</span>
 
167
    </td><td class="summary">
 
168
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
169
        <tr>
 
170
          <td><span class="summary-sig"><a href="lib.scripting.Clipboard-class.html#fill_clipboard" class="summary-sig-name">fill_clipboard</a>(<span class="summary-sig-arg">self</span>,
 
171
        <span class="summary-sig-arg">contents</span>)</span><br />
 
172
      Copy text into the clipboard</td>
 
173
          <td align="right" valign="top">
 
174
            <span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.fill_clipboard">source&nbsp;code</a></span>
 
175
            
 
176
          </td>
 
177
        </tr>
 
178
      </table>
 
179
      
 
180
    </td>
 
181
  </tr>
 
182
<tr class="private">
 
183
    <td width="15%" align="right" valign="top" class="summary">
 
184
      <span class="summary-type">&nbsp;</span>
 
185
    </td><td class="summary">
 
186
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
187
        <tr>
 
188
          <td><span class="summary-sig"><a name="__fillClipboard"></a><span class="summary-sig-name">__fillClipboard</span>(<span class="summary-sig-arg">self</span>,
 
189
        <span class="summary-sig-arg">contents</span>)</span></td>
 
190
          <td align="right" valign="top">
 
191
            <span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.__fillClipboard">source&nbsp;code</a></span>
 
192
            
 
193
          </td>
 
194
        </tr>
 
195
      </table>
 
196
      
 
197
    </td>
 
198
  </tr>
 
199
<tr>
 
200
    <td width="15%" align="right" valign="top" class="summary">
 
201
      <span class="summary-type">&nbsp;</span>
 
202
    </td><td class="summary">
 
203
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
204
        <tr>
 
205
          <td><span class="summary-sig"><a href="lib.scripting.Clipboard-class.html#get_clipboard" class="summary-sig-name">get_clipboard</a>(<span class="summary-sig-arg">self</span>)</span><br />
 
206
      Read text from the clipboard</td>
 
207
          <td align="right" valign="top">
 
208
            <span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.get_clipboard">source&nbsp;code</a></span>
 
209
            
 
210
          </td>
 
211
        </tr>
 
212
      </table>
 
213
      
 
214
    </td>
 
215
  </tr>
 
216
<tr class="private">
 
217
    <td width="15%" align="right" valign="top" class="summary">
 
218
      <span class="summary-type">&nbsp;</span>
 
219
    </td><td class="summary">
 
220
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
221
        <tr>
 
222
          <td><span class="summary-sig"><a name="__getClipboard"></a><span class="summary-sig-name">__getClipboard</span>(<span class="summary-sig-arg">self</span>)</span></td>
 
223
          <td align="right" valign="top">
 
224
            <span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.__getClipboard">source&nbsp;code</a></span>
 
225
            
 
226
          </td>
 
227
        </tr>
 
228
      </table>
 
229
      
 
230
    </td>
 
231
  </tr>
 
232
<tr class="private">
 
233
    <td width="15%" align="right" valign="top" class="summary">
 
234
      <span class="summary-type">&nbsp;</span>
 
235
    </td><td class="summary">
 
236
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
237
        <tr>
 
238
          <td><span class="summary-sig"><a name="__execAsync"></a><span class="summary-sig-name">__execAsync</span>(<span class="summary-sig-arg">self</span>,
 
239
        <span class="summary-sig-arg">callback</span>,
 
240
        <span class="summary-sig-arg">*args</span>)</span></td>
 
241
          <td align="right" valign="top">
 
242
            <span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.__execAsync">source&nbsp;code</a></span>
 
243
            
 
244
          </td>
 
245
        </tr>
 
246
      </table>
 
247
      
 
248
    </td>
 
249
  </tr>
 
250
</table>
 
251
<!-- ==================== METHOD DETAILS ==================== -->
 
252
<a name="section-MethodDetails"></a>
 
253
<table class="details" border="1" cellpadding="3"
 
254
       cellspacing="0" width="100%" bgcolor="white">
 
255
<tr bgcolor="#70b0f0" class="table-header">
 
256
  <td colspan="2" class="table-header">
 
257
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
258
      <tr valign="top">
 
259
        <td align="left"><span class="table-header">Method Details</span></td>
 
260
        <td align="right" valign="top"
 
261
         ><span class="options">[<a href="#section-MethodDetails"
 
262
         class="privatelink" onclick="toggle_private();"
 
263
         >hide private</a>]</span></td>
 
264
      </tr>
 
265
    </table>
 
266
  </td>
 
267
</tr>
 
268
</table>
 
269
<a name="fill_selection"></a>
 
270
<div>
 
271
<table class="details" border="1" cellpadding="3"
 
272
       cellspacing="0" width="100%" bgcolor="white">
 
273
<tr><td>
 
274
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
275
  <tr valign="top"><td>
 
276
  <h3 class="epydoc"><span class="sig"><span class="sig-name">fill_selection</span>(<span class="sig-arg">self</span>,
 
277
        <span class="sig-arg">contents</span>)</span>
 
278
  </h3>
 
279
  </td><td align="right" valign="top"
 
280
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.fill_selection">source&nbsp;code</a></span>&nbsp;
 
281
    </td>
 
282
  </tr></table>
 
283
  
 
284
  <p>Copy text into the X selection</p>
 
285
  <p>Usage: <code>clipboard.fill_selection(contents)</code></p>
 
286
  <dl class="fields">
 
287
    <dt>Parameters:</dt>
 
288
    <dd><ul class="nomargin-top">
 
289
        <li><strong class="pname"><code>contents</code></strong> - string to be placed in the selection</li>
 
290
    </ul></dd>
 
291
  </dl>
 
292
</td></tr></table>
 
293
</div>
 
294
<a name="get_selection"></a>
 
295
<div>
 
296
<table class="details" border="1" cellpadding="3"
 
297
       cellspacing="0" width="100%" bgcolor="white">
 
298
<tr><td>
 
299
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
300
  <tr valign="top"><td>
 
301
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_selection</span>(<span class="sig-arg">self</span>)</span>
 
302
  </h3>
 
303
  </td><td align="right" valign="top"
 
304
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.get_selection">source&nbsp;code</a></span>&nbsp;
 
305
    </td>
 
306
  </tr></table>
 
307
  
 
308
  <p>Read text from the X selection</p>
 
309
  <p>Usage: <code>clipboard.get_selection()</code></p>
 
310
  <dl class="fields">
 
311
  </dl>
 
312
</td></tr></table>
 
313
</div>
 
314
<a name="fill_clipboard"></a>
 
315
<div>
 
316
<table class="details" border="1" cellpadding="3"
 
317
       cellspacing="0" width="100%" bgcolor="white">
 
318
<tr><td>
 
319
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
320
  <tr valign="top"><td>
 
321
  <h3 class="epydoc"><span class="sig"><span class="sig-name">fill_clipboard</span>(<span class="sig-arg">self</span>,
 
322
        <span class="sig-arg">contents</span>)</span>
 
323
  </h3>
 
324
  </td><td align="right" valign="top"
 
325
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.fill_clipboard">source&nbsp;code</a></span>&nbsp;
 
326
    </td>
 
327
  </tr></table>
 
328
  
 
329
  <p>Copy text into the clipboard</p>
 
330
  <p>Usage: <code>clipboard.fill_clipboard(contents)</code></p>
 
331
  <dl class="fields">
 
332
    <dt>Parameters:</dt>
 
333
    <dd><ul class="nomargin-top">
 
334
        <li><strong class="pname"><code>contents</code></strong> - string to be placed in the selection</li>
 
335
    </ul></dd>
 
336
  </dl>
 
337
</td></tr></table>
 
338
</div>
 
339
<a name="get_clipboard"></a>
 
340
<div>
 
341
<table class="details" border="1" cellpadding="3"
 
342
       cellspacing="0" width="100%" bgcolor="white">
 
343
<tr><td>
 
344
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
345
  <tr valign="top"><td>
 
346
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_clipboard</span>(<span class="sig-arg">self</span>)</span>
 
347
  </h3>
 
348
  </td><td align="right" valign="top"
 
349
    ><span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.get_clipboard">source&nbsp;code</a></span>&nbsp;
 
350
    </td>
 
351
  </tr></table>
 
352
  
 
353
  <p>Read text from the clipboard</p>
 
354
  <p>Usage: <code>clipboard.get_clipboard()</code></p>
 
355
  <dl class="fields">
 
356
  </dl>
 
357
</td></tr></table>
 
358
</div>
 
359
<br />
 
360
<!-- ==================== NAVIGATION BAR ==================== -->
 
361
<table class="navbar" border="0" width="100%" cellpadding="0"
 
362
       bgcolor="#a0c0ff" cellspacing="0">
 
363
  <tr valign="middle">
 
364
  <!-- Home link -->
 
365
      <th>&nbsp;&nbsp;&nbsp;<a
 
366
        href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
367
 
 
368
  <!-- Tree link -->
 
369
      <th>&nbsp;&nbsp;&nbsp;<a
 
370
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
371
 
 
372
  <!-- Index link -->
 
373
      <th>&nbsp;&nbsp;&nbsp;<a
 
374
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
375
 
 
376
  <!-- Help link -->
 
377
      <th>&nbsp;&nbsp;&nbsp;<a
 
378
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
379
 
 
380
      <th class="navbar" width="100%"></th>
 
381
  </tr>
 
382
</table>
 
383
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
384
  <tr>
 
385
    <td align="left" class="footer">
 
386
    Generated by Epydoc 3.0.1 on Thu Aug 13 13:17:08 2009
 
387
    </td>
 
388
    <td align="right" class="footer">
 
389
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
 
390
        >http://epydoc.sourceforge.net</a>
 
391
    </td>
 
392
  </tr>
 
393
</table>
 
394
 
 
395
<script type="text/javascript">
 
396
  <!--
 
397
  // Private objects are initially displayed (because if
 
398
  // javascript is turned off then we want them to be
 
399
  // visible); but by default, we want to hide them.  So hide
 
400
  // them unless we have a cookie that says to show them.
 
401
  checkCookie();
 
402
  // -->
 
403
</script>
 
404
</body>
 
405
</html>