Debian Codegraph @

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