phoenix_title wx.Clipboard

A class for manipulating the clipboard.

To use the clipboard, you call member functions of the global TheClipboard object.

See the DataObject Overview for further information.

Call wx.Clipboard.Open to get ownership of the clipboard. If this operation returns True, you now own the clipboard. Call wx.Clipboard.SetData to put data on the clipboard, or wx.Clipboard.GetData to retrieve data from the clipboard. Call 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()

Note

On GTK, the clipboard behavior can vary depending on the configuration of the end-user’s machine. In order for the clipboard data to persist after the window closes, a clipboard manager must be installed. Some clipboard managers will automatically flush the clipboard after each new piece of data is added, while others will not. The () function will force the clipboard manager to flush the data.


class_hierarchy Class Hierarchy

Inheritance diagram for class Clipboard:

method_summary Methods Summary

__init__

Default constructor.

AddData

Call this function to add the data object to the clipboard.

Clear

Clears the global clipboard object and the system’s clipboard if possible.

Close

Call this function to close the clipboard, having opened it with Open .

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.

Get

Returns the global instance (wxTheClipboard) of the clipboard object.

GetData

Call this function to fill data with data on the clipboard, if available in the required format.

IsOpened

Returns True if the clipboard has been opened.

IsSupported

Returns True if there is data which matches the data format of the given data object currently available on the clipboard.

IsUsingPrimarySelection

Returns True if we are using the primary selection, False if clipboard one.

Open

Call this function to open the clipboard before calling SetData and GetData .

SetData

Call this function to set the data object to the clipboard.

UsePrimarySelection

On platforms supporting it (all X11-based ports), 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.


Methods

__init__(self)

Default constructor.



AddData(self, data)

Call this function to add the data object to the clipboard.

This is an obsolete synonym for SetData .

Parameters

data (wx.DataObject) –

Return type

bool



Clear(self)

Clears the global clipboard object and the system’s clipboard if possible.



Close(self)

Call this function to close the clipboard, having opened it with Open .



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 implemented in MSW and GTK and always returns False otherwise.

Return type

bool

Returns

False if the operation is unsuccessful for any reason.

Note

On GTK, only the non-primary selection can be flushed. Calling this function when the clipboard is using the primary selection will return False and not make any data available after the program exits.



static Get()

Returns the global instance (wxTheClipboard) of the clipboard object.

Return type

wx.Clipboard



GetData(self, data)

Call this function to fill data with data on the clipboard, if available in the required format.

Returns True on success.

Parameters

data (wx.DataObject) –

Return type

bool



IsOpened(self)

Returns True if the clipboard has been opened.

Return type

bool



IsSupported(self, format)

Returns True if there is data which matches the data format of the given data object currently available on the clipboard.

Parameters

format (wx.DataFormat) –

Return type

bool

Todo

The name of this function is misleading. This should be renamed to something that more accurately indicates what it does.



IsUsingPrimarySelection(self)

Returns True if we are using the primary selection, False if clipboard one.

Return type

bool



Open(self)

Call this function to open the clipboard before calling SetData and GetData .

Call Close when you have finished with the clipboard. You should keep the clipboard open for only a very short time.

Return type

bool

Returns

True on success. This should be tested (as in the sample shown above).



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.

Parameters

data (wx.DataObject) –

Return type

bool



UsePrimarySelection(self, primary=False)

On platforms supporting it (all X11-based ports), 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 implementing 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.

Parameters

primary (bool) –