.. include:: headings.inc .. _Clipboard: ========================================================================================================================================== |phoenix_title| **Clipboard** ========================================================================================================================================== A class for manipulating the clipboard. To use the clipboard, you call member functions of the global :meth:`~Clipboard.TheClipboard` object. See the :ref:`DataObject Overview ` for further information. Call :meth:`Clipboard.Open` to get ownership of the clipboard. If this operation returns ``True``, you now own the clipboard. Call :meth:`Clipboard.SetData` to put data on the clipboard, or :meth:`Clipboard.GetData` to retrieve data from the clipboard. Call :meth:`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(): # This data objects are held by the clipboard, # so do not delete them in the app. wx.TheClipboard.SetData(wx.TextDataObject("Some text")) wx.TheClipboard.Close() # Read some text if wx.TheClipboard.Open(): if wx.TheClipboard.IsSupported(wx.DF_TEXT): data = wx.TextDataObject() wx.TheClipboard.GetData(data) wx.MessageBox(data.GetText()) wx.TheClipboard.Close() .. seealso:: :ref:`Drag and Drop Overview `, :ref:`DataObject Overview `, :ref:`DataObject` | |class_hierarchy| Inheritance Diagram ===================================== Inheritance diagram for class **Clipboard** .. raw:: html

Inheritance diagram of Clipboard

| |method_summary| Methods Summary ================================ ================================================================================ ================================================================================ :meth:`~Clipboard.__init__` Default constructor. :meth:`~Clipboard.AddData` Call this function to add the data object to the clipboard. :meth:`~Clipboard.Clear` Clears the global clipboard object and the system's clipboard if possible. :meth:`~Clipboard.Close` Call this function to close the clipboard, having opened it with :meth:`Open` . :meth:`~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:`~Clipboard.Get` Returns the global instance (wxTheClipboard) of the clipboard object. :meth:`~Clipboard.GetData` Call this function to fill `data` with data on the clipboard, if available in the required format. :meth:`~Clipboard.IsOpened` Returns ``True`` if the clipboard has been opened. :meth:`~Clipboard.IsSupported` Returns ``True`` if there is data which matches the data format of the given data object currently **available** on the clipboard. :meth:`~Clipboard.IsUsingPrimarySelection` Returns ``True`` if we are using the primary selection, ``False`` if clipboard one. :meth:`~Clipboard.Open` Call this function to open the clipboard before calling :meth:`SetData` and :meth:`GetData` . :meth:`~Clipboard.SetData` Call this function to set the data object to the clipboard. :meth:`~Clipboard.UsePrimarySelection` On platforms supporting it (all X11-based ports), :ref:`Clipboard` uses the ``CLIPBOARD`` X11 selection by default. :meth:`~Clipboard.__enter__` :meth:`~Clipboard.__exit__` ================================================================================ ================================================================================ | |api| Class API =============== .. class:: Clipboard(Object) A class for manipulating the clipboard. **Possible constructors**:: Clipboard() .. method:: __init__(self) Default constructor. .. method:: AddData(self, data) Call this function to add the data object to the clipboard. You may call this function repeatedly after having cleared the clipboard using :meth:`Clear` . After this function has been called, the clipboard owns the data, so do not delete the data explicitly. :param `data`: :type `data`: DataObject :rtype: `bool` .. seealso:: :meth:`SetData` .. 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:`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`: 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`: 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. This function will clear all previous contents in the clipboard, so calling it several times does not make any sense. After this function has been called, the clipboard owns the data, so do not delete the data explicitly. :param `data`: :type `data`: DataObject :rtype: `bool` .. seealso:: :meth:`AddData` .. method:: UsePrimarySelection(self, primary=False) On platforms supporting it (all X11-based ports), :ref:`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 .. method:: __enter__(self) .. method:: __exit__(self, exc_type, exc_val, exc_tb)