typo (patch 1528925)

[wxWidgets.git] / docs / latex / wx / clipbrd.tex

\section{\class{wxClipboard}}\label{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 {\bf wxTheClipboard} object.

See also the \helpref{wxDataObject overview}{wxdataobjectoverview} for further information.

Call \helpref{wxClipboard::Open}{wxclipboardopen} to get ownership of the clipboard. If this operation returns true, you
now own the clipboard. Call \helpref{wxClipboard::SetData}{wxclipboardsetdata} to put data
on the clipboard, or \helpref{wxClipboard::GetData}{wxclipboardgetdata} to
retrieve data from the clipboard. Call \helpref{wxClipboard::Close}{wxclipboardclose} to close
the clipboard and relinquish ownership. You should keep the clipboard open only momentarily.

For example:

\begin{verbatim}
  // 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();
  }
\end{verbatim}

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/clipbrd.h>

\wxheading{See also}

\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxClipboard::wxClipboard}\label{wxclipboardctor}

\func{}{wxClipboard}{\void}

Constructor.

\membersection{wxClipboard::\destruct{wxClipboard}}\label{wxclipboarddtor}

\func{}{\destruct{wxClipboard}}{\void}

Destructor.

\membersection{wxClipboard::AddData}\label{wxclipboardadddata}

\func{bool}{AddData}{\param{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 \helpref{wxClipboard::Clear}{wxclipboardclear}.

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

\wxheading{See also}

\helpref{wxClipboard::SetData}{wxclipboardsetdata}

\membersection{wxClipboard::Clear}\label{wxclipboardclear}

\func{void}{Clear}{\void}

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

\membersection{wxClipboard::Close}\label{wxclipboardclose}

\func{void}{Close}{\void}

Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Open}{wxclipboardopen}.

\membersection{wxClipboard::Flush}\label{wxclipboardflush}

\func{bool}{Flush}{\void}

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.

\membersection{wxClipboard::GetData}\label{wxclipboardgetdata}

\func{bool}{GetData}{\param{wxDataObject\&}{ data}}

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

\membersection{wxClipboard::IsOpened}\label{wxclipboardisopened}

\constfunc{bool}{IsOpened}{\void}

Returns true if the clipboard has been opened.

\membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}

\func{bool}{IsSupported}{\param{const wxDataFormat\&}{ format}}

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

\membersection{wxClipboard::Open}\label{wxclipboardopen}

\func{bool}{Open}{\void}

Call this function to open the clipboard before calling \helpref{wxClipboard::SetData}{wxclipboardsetdata} 
and \helpref{wxClipboard::GetData}{wxclipboardgetdata}.

Call \helpref{wxClipboard::Close}{wxclipboardclose} 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).

\membersection{wxClipboard::SetData}\label{wxclipboardsetdata}

\func{bool}{SetData}{\param{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.

\wxheading{See also}

\helpref{wxClipboard::AddData}{wxclipboardadddata}

\membersection{wxClipboard::UsePrimarySelection}\label{wxclipboarduseprimary}

\func{void}{UsePrimarySelection}{\param{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 {\it primary} is true.