wxClipboard

A class for manipulating the clipboard. Note that this is not compatible with the clipboard class from wxWidgets 1.xx, which has the same name but a different implementation.

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

See also 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();
  }

wxObject

Include files

<wx/clipbrd.h>

See also

Drag and drop overview, wxDataObject

Members

wxClipboard::wxClipboard
wxClipboard::~wxClipboard
wxClipboard::AddData
wxClipboard::Clear
wxClipboard::Close
wxClipboard::Flush
wxClipboard::GetData
wxClipboard::IsOpened
wxClipboard::IsSupported
wxClipboard::Open
wxClipboard::SetData
wxClipboard::UsePrimarySelection

wxClipboard::wxClipboard

wxClipboard()

Constructor.

wxClipboard::~wxClipboard

~wxClipboard()

Destructor.

wxClipboard::AddData

bool AddData(wxDataObject* data)

Call this function to add the data object to the clipboard. You may call this function repeatedly after having cleared the clipboard using wxClipboard::Clear.

After this function has been called, the clipboard owns the data, so do not delete the data explicitly.

See also

wxClipboard::SetData

wxClipboard::Clear

void Clear()

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

wxClipboard::Close

void Close()

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

wxClipboard::Flush

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. Returns false if the operation is unsuccessful for any reason.

wxClipboard::GetData

bool GetData(wxDataObject& data)

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

wxClipboard::IsOpened

bool IsOpened() const

Returns true if the clipboard has been opened.

wxClipboard::IsSupported

bool IsSupported(const wxDataFormat& format)

Returns true if there is data which matches the data format of the given data object currently available (IsSupported sounds like a misnomer, FIXME: better deprecate this name?) on the clipboard.

wxClipboard::Open

bool Open()

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

Call wxClipboard::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).

wxClipboard::SetData

bool SetData(wxDataObject* 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.

See also

wxClipboard::AddData

wxClipboard::UsePrimarySelection

void UsePrimarySelection(bool primary = true)

On platforms supporting it (currently only GTK), selects the so called PRIMARY SELECTION as the clipboard as opposed to the normal clipboard, if primary is true.