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">
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>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="lib.scripting-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<th class="navbar" width="100%"></th>
36
<table width="100%" cellpadding="0" cellspacing="0">
39
<span class="breadcrumbs">
41
<a href="lib.scripting-module.html">Module scripting</a> ::
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.Clipboard-class.html"
53
target="_top">no frames</a>]</span></td></tr>
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 code</a></span></p>
60
<p>Read/write access to the X selection and clipboard</p>
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%">
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>
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">
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 code</a></span>
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">
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 code</a></span>
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">
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 code</a></span>
132
<td width="15%" align="right" valign="top" class="summary">
133
<span class="summary-type"> </span>
134
</td><td class="summary">
135
<table width="100%" cellpadding="0" cellspacing="0" border="0">
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 code</a></span>
149
<td width="15%" align="right" valign="top" class="summary">
150
<span class="summary-type"> </span>
151
</td><td class="summary">
152
<table width="100%" cellpadding="0" cellspacing="0" border="0">
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 code</a></span>
165
<td width="15%" align="right" valign="top" class="summary">
166
<span class="summary-type"> </span>
167
</td><td class="summary">
168
<table width="100%" cellpadding="0" cellspacing="0" border="0">
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 code</a></span>
183
<td width="15%" align="right" valign="top" class="summary">
184
<span class="summary-type"> </span>
185
</td><td class="summary">
186
<table width="100%" cellpadding="0" cellspacing="0" border="0">
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 code</a></span>
200
<td width="15%" align="right" valign="top" class="summary">
201
<span class="summary-type"> </span>
202
</td><td class="summary">
203
<table width="100%" cellpadding="0" cellspacing="0" border="0">
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 code</a></span>
217
<td width="15%" align="right" valign="top" class="summary">
218
<span class="summary-type"> </span>
219
</td><td class="summary">
220
<table width="100%" cellpadding="0" cellspacing="0" border="0">
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 code</a></span>
233
<td width="15%" align="right" valign="top" class="summary">
234
<span class="summary-type"> </span>
235
</td><td class="summary">
236
<table width="100%" cellpadding="0" cellspacing="0" border="0">
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 code</a></span>
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%">
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>
269
<a name="fill_selection"></a>
271
<table class="details" border="1" cellpadding="3"
272
cellspacing="0" width="100%" bgcolor="white">
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>
279
</td><td align="right" valign="top"
280
><span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.fill_selection">source code</a></span>
284
<p>Copy text into the X selection</p>
285
<p>Usage: <code>clipboard.fill_selection(contents)</code></p>
288
<dd><ul class="nomargin-top">
289
<li><strong class="pname"><code>contents</code></strong> - string to be placed in the selection</li>
294
<a name="get_selection"></a>
296
<table class="details" border="1" cellpadding="3"
297
cellspacing="0" width="100%" bgcolor="white">
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>
303
</td><td align="right" valign="top"
304
><span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.get_selection">source code</a></span>
308
<p>Read text from the X selection</p>
309
<p>Usage: <code>clipboard.get_selection()</code></p>
314
<a name="fill_clipboard"></a>
316
<table class="details" border="1" cellpadding="3"
317
cellspacing="0" width="100%" bgcolor="white">
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>
324
</td><td align="right" valign="top"
325
><span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.fill_clipboard">source code</a></span>
329
<p>Copy text into the clipboard</p>
330
<p>Usage: <code>clipboard.fill_clipboard(contents)</code></p>
333
<dd><ul class="nomargin-top">
334
<li><strong class="pname"><code>contents</code></strong> - string to be placed in the selection</li>
339
<a name="get_clipboard"></a>
341
<table class="details" border="1" cellpadding="3"
342
cellspacing="0" width="100%" bgcolor="white">
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>
348
</td><td align="right" valign="top"
349
><span class="codelink"><a href="lib.scripting-pysrc.html#Clipboard.get_clipboard">source code</a></span>
353
<p>Read text from the clipboard</p>
354
<p>Usage: <code>clipboard.get_clipboard()</code></p>
360
<!-- ==================== NAVIGATION BAR ==================== -->
361
<table class="navbar" border="0" width="100%" cellpadding="0"
362
bgcolor="#a0c0ff" cellspacing="0">
365
<th> <a
366
href="lib.scripting-module.html">Home</a> </th>
369
<th> <a
370
href="module-tree.html">Trees</a> </th>
373
<th> <a
374
href="identifier-index.html">Indices</a> </th>
377
<th> <a
378
href="help.html">Help</a> </th>
380
<th class="navbar" width="100%"></th>
383
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
385
<td align="left" class="footer">
386
Generated by Epydoc 3.0.1 on Thu Aug 13 13:17:08 2009
388
<td align="right" class="footer">
389
<a target="mainFrame" href="http://epydoc.sourceforge.net"
390
>http://epydoc.sourceforge.net</a>
395
<script type="text/javascript">
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.