wxClipboard Class Reference

#include <wx/clipbrd.h>

Inheritance diagram for wxClipboard:

Detailed Description

A class for manipulating the clipboard.

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

See the wxDataObject Overview for further information.

Call wxClipboard::Open() to get ownership of the clipboard. If this operation returns true, you now own the clipboard. Call wxClipboard::SetData() to put data on the clipboard, or wxClipboard::GetData() to retrieve data from the clipboard. Call wxClipboard::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 (wxTheClipboard->Open())
{
    // This data objects are held by the clipboard,
    // so do not delete them in the app.
    wxTheClipboard->SetData( new wxTextDataObject("Some text") );
    wxTheClipboard->Close();
}
 
// Read some text
if (wxTheClipboard->Open())
{
    if (wxTheClipboard->IsSupported( wxDF_TEXT ))
    {
        wxTextDataObject data;
        wxTheClipboard->GetData( data );
        wxMessageBox( data.GetText() );
    }
    wxTheClipboard->Close();
}

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 Flush() function will force the clipboard manager to flush the data.

Library:  wxCore

Category:  Clipboard and Drag & Drop

See also

Drag and Drop Overview, wxDataObject Overview, wxDataObject

Public Member Functions
	wxClipboard ()
	Default constructor. More...
virtual	~wxClipboard ()
	Destructor. More...
virtual bool	AddData (wxDataObject *data)
	Call this function to add the data object to the clipboard. More...
virtual void	Clear ()
	Clears the global clipboard object and the system's clipboard if possible. More...
virtual void	Close ()
	Call this function to close the clipboard, having opened it with Open(). More...
virtual bool	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. More...
virtual bool	GetData (wxDataObject &data)
	Call this function to fill data with data on the clipboard, if available in the required format. More...
virtual bool	IsOpened () const
	Returns true if the clipboard has been opened. More...
virtual bool	IsSupported (const wxDataFormat &format)
	Returns true if there is data which matches the data format of the given data object currently available on the clipboard. More...
bool	IsUsingPrimarySelection () const
	Returns true if we are using the primary selection, false if clipboard one. More...
virtual bool	Open ()
	Call this function to open the clipboard before calling SetData() and GetData(). More...
virtual bool	SetData (wxDataObject *data)
	Call this function to set the data object to the clipboard. More...
virtual void	UsePrimarySelection (bool primary=false)
	On platforms supporting it (all X11-based ports), wxClipboard uses the CLIPBOARD X11 selection by default. More...
Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to NULL the internal reference data. More...
	wxObject (const wxObject &other)
	Copy ctor. More...
virtual	~wxObject ()
	Destructor. More...
virtual wxClassInfo *	GetClassInfo () const
	This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class. More...
bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj. More...
void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone. More...
void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer. More...
void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
void	UnShare ()
	This is the same of AllocExclusive() but this method is public. More...
void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...
void *	operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
	The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...

Static Public Member Functions
static wxClipboard *	Get ()
	Returns the global instance (wxTheClipboard) of the clipboard object. More...

Additional Inherited Members
Protected Member Functions inherited from wxObject
void	AllocExclusive ()
	Ensure that this object's data is not shared with any other object. More...
virtual wxObjectRefData *	CreateRefData () const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
virtual wxObjectRefData *	CloneRefData (const wxObjectRefData *data) const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data. More...

Constructor & Destructor Documentation

wxClipboard()

wxClipboard::wxClipboard

(

)

Default constructor.

~wxClipboard()

virtual wxClipboard::~wxClipboard ( )

virtual

Destructor.

Member Function Documentation

AddData()

virtual bool wxClipboard::AddData ( wxDataObject *  data )

virtual

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

This is an obsolete synonym for SetData().

Clear()

virtual void wxClipboard::Clear ( )

virtual

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

Close()

virtual void wxClipboard::Close ( )

virtual

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

Flush()

virtual bool wxClipboard::Flush ( )

virtual

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.

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.

Returns

false if the operation is unsuccessful for any reason.

Get()

static wxClipboard* wxClipboard::Get ( )

static

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

GetData()

virtual bool wxClipboard::GetData ( wxDataObject &  data )

virtual

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

Returns true on success.

IsOpened()

virtual bool wxClipboard::IsOpened ( ) const

virtual

Returns true if the clipboard has been opened.

IsSupported()

virtual bool wxClipboard::IsSupported ( const wxDataFormat &  format )

virtual

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

Todo:

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

IsUsingPrimarySelection()

bool wxClipboard::IsUsingPrimarySelection

(

)

const

Returns true if we are using the primary selection, false if clipboard one.

See also

UsePrimarySelection()

Open()

virtual bool wxClipboard::Open ( )

virtual

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.

Returns

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

SetData()

virtual bool wxClipboard::SetData ( wxDataObject *  data )

virtual

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.

UsePrimarySelection()

virtual void wxClipboard::UsePrimarySelection ( bool  primary = false )

virtual

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