1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.Clipboard:
==========================================================================================================================================
|phoenix_title| **wx.Clipboard**
==========================================================================================================================================
A class for manipulating the clipboard.
To use the clipboard, you call member functions of the global :meth:`~wx.Clipboard.TheClipboard` object.
See the :ref:`DataObject Overview <dataobject overview>` for further information.
Call :meth:`wx.Clipboard.Open` to get ownership of the clipboard. If this operation returns ``True``, you now own the clipboard. Call :meth:`wx.Clipboard.SetData` to put data on the clipboard, or :meth:`wx.Clipboard.GetData` to retrieve data from the clipboard. Call :meth:`wx.Clipboard.Close` to close the clipboard and relinquish ownership. You should keep the clipboard open only momentarily.
For example:
::
# Write some text to the clipboard
if wx.TheClipboard.Open():
wx.TheClipboard.SetData(wx.TextDataObject("Some text"))
wx.TheClipboard.Close()
# Test if text content is available
not_empty = wx.TheClipboard.IsSupported(wx.DataFormat(wx.DF_TEXT))
# Read some text
text_data = wx.TextDataObject()
if wx.TheClipboard.Open():
success = wx.TheClipboard.GetData(text_data)
wx.TheClipboard.Close()
if success:
return text_data.GetText()
.. seealso:: :ref:`Drag and Drop Overview <drag and drop overview>`, :ref:`DataObject Overview <dataobject overview>`, :ref:`wx.DataObject`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>Clipboard</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.Clipboard_inheritance.png" alt="Inheritance diagram of Clipboard" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Object.html" title="wx.Object" alt="" coords="15,5,96,35"/> <area shape="rect" id="node2" href="wx.Clipboard.html" title="wx.Clipboard" alt="" coords="5,83,107,112"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Clipboard.__init__` Default constructor.
:meth:`~wx.Clipboard.AddData` Call this function to add the data object to the clipboard.
:meth:`~wx.Clipboard.Clear` Clears the global clipboard object and the system's clipboard if possible.
:meth:`~wx.Clipboard.Close` Call this function to close the clipboard, having opened it with :meth:`~Clipboard.Open` .
:meth:`~wx.Clipboard.Flush` Flushes the clipboard: this means that the data which is currently on clipboard will stay available even after the application exits (possibly eating memory), otherwise the clipboard will be emptied on exit.
:meth:`~wx.Clipboard.Get` Returns the global instance (wxTheClipboard) of the clipboard object.
:meth:`~wx.Clipboard.GetData` Call this function to fill `data` with data on the clipboard, if available in the required format.
:meth:`~wx.Clipboard.IsOpened` Returns ``True`` if the clipboard has been opened.
:meth:`~wx.Clipboard.IsSupported` Returns ``True`` if there is data which matches the data format of the given data object currently **available** on the clipboard.
:meth:`~wx.Clipboard.IsUsingPrimarySelection` Returns ``True`` if we are using the primary selection, ``False`` if clipboard one.
:meth:`~wx.Clipboard.Open` Call this function to open the clipboard before calling :meth:`~Clipboard.SetData` and :meth:`~Clipboard.GetData` .
:meth:`~wx.Clipboard.SetData` Call this function to set the data object to the clipboard.
:meth:`~wx.Clipboard.UsePrimarySelection` On platforms supporting it (all X11-based ports), :ref:`wx.Clipboard` uses the ``CLIPBOARD`` X11 selection by default.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Clipboard(Object)
**Possible constructors**::
Clipboard()
A class for manipulating the clipboard.
.. method:: __init__(self)
Default constructor.
.. method:: AddData(self, data)
Call this function to add the data object to the clipboard.
This is an obsolete synonym for :meth:`SetData` .
:param `data`:
:type `data`: wx.DataObject
:rtype: `bool`
.. method:: Clear(self)
Clears the global clipboard object and the system's clipboard if possible.
.. method:: Close(self)
Call this function to close the clipboard, having opened it with :meth:`Open` .
.. method:: Flush(self)
Flushes the clipboard: this means that the data which is currently on clipboard will stay available even after the application exits (possibly eating memory), otherwise the clipboard will be emptied on exit.
Currently this method is not implemented in X11-based ports, i.e. wxGTK, X11 and Motif and always returns ``False`` there.
:rtype: `bool`
:returns:
``False`` if the operation is unsuccessful for any reason.
.. staticmethod:: Get()
Returns the global instance (wxTheClipboard) of the clipboard object.
:rtype: :ref:`wx.Clipboard`
.. method:: GetData(self, data)
Call this function to fill `data` with data on the clipboard, if available in the required format.
Returns ``True`` on success.
:param `data`:
:type `data`: wx.DataObject
:rtype: `bool`
.. method:: IsOpened(self)
Returns ``True`` if the clipboard has been opened.
:rtype: `bool`
.. method:: IsSupported(self, format)
Returns ``True`` if there is data which matches the data format of the given data object currently **available** on the clipboard.
:param `format`:
:type `format`: wx.DataFormat
:rtype: `bool`
.. todo:: The name of this function is misleading. This should be renamed to something that more accurately indicates what it does.
.. method:: IsUsingPrimarySelection(self)
Returns ``True`` if we are using the primary selection, ``False`` if clipboard one.
:rtype: `bool`
.. seealso:: :meth:`UsePrimarySelection`
.. method:: Open(self)
Call this function to open the clipboard before calling :meth:`SetData` and :meth:`GetData` .
Call :meth:`Close` when you have finished with the clipboard. You should keep the clipboard open for only a very short time.
:rtype: `bool`
:returns:
``True`` on success. This should be tested (as in the sample shown above).
.. method:: SetData(self, data)
Call this function to set the data object to the clipboard.
The new data object replaces any previously set one, so if the application wants to provide clipboard data in several different formats, it must use a composite data object supporting all of the formats instead of calling this function several times with different data objects as this would only leave data from the last one in the clipboard.
After this function has been called, the clipboard owns the data, so do not delete the data explicitly.
:param `data`:
:type `data`: wx.DataObject
:rtype: `bool`
.. method:: UsePrimarySelection(self, primary=False)
On platforms supporting it (all X11-based ports), :ref:`wx.Clipboard` uses the ``CLIPBOARD`` X11 selection by default.
When this function is called with ``True``, all subsequent clipboard operations will use ``PRIMARY`` selection until this function is called again with ``False``.
On the other platforms, there is no ``PRIMARY`` selection and so all clipboard operations will fail. This allows to implement the standard X11 handling of the clipboard which consists in copying data to the ``CLIPBOARD`` selection only when the user explicitly requests it (i.e. by selecting the "Copy" menu command) but putting the currently selected text into the ``PRIMARY`` selection automatically, without overwriting the normal clipboard contents with the currently selected text on the other platforms.
:param `primary`:
:type `primary`: bool
|
