954b8ae603
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1698 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
117 lines
3.6 KiB
TeX
117 lines
3.6 KiB
TeX
\section{\class{wxClipboard}}\label{wxclipboard}
|
|
|
|
A class for manipulating the clipboard. Note that this is not compatible with the
|
|
clipboard class from wxWindows 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.
|
|
|
|
Call \helpref{wxClipboard::Open}{wxclipboardopen} to get ownership of the clipboard. If this operation returns TRUE, you
|
|
now own the clipboard. Call \helpref{wxClipboard::AddData}{wxclipboardadddata} to put data
|
|
on the clipboard (one or more times), 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->AddData( new wxTextDataObject("Some text") );
|
|
wxTheClipboard->Close();
|
|
}
|
|
|
|
// Read some text
|
|
if (wxTheClipboard->Open())
|
|
{
|
|
wxTextDataObject data;
|
|
if (wxTheClipboard->IsSupported(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}
|
|
|
|
\func{}{wxClipboard}{\void}
|
|
|
|
Constructor.
|
|
|
|
\membersection{wxClipboard::\destruct{wxClipboard}}
|
|
|
|
\func{}{\destruct{wxClipboard}}{\void}
|
|
|
|
Destructor.
|
|
|
|
\membersection{wxClipboard::AddData}\label{wxclipboardadddata}
|
|
|
|
\func{bool}{AddData}{\param{wxDataObject*}{ data}}
|
|
|
|
Call this function to add a data object to the clipboard. This function can be called several times
|
|
to put different formats on the clipboard.
|
|
|
|
\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{bool}{Close}{\void}
|
|
|
|
Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Open}{wxclipboardopen}.
|
|
|
|
\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::IsSupported}\label{wxclipboardissupported}
|
|
|
|
\func{bool}{IsSupported}{\param{wxDataObject&}{ data}}
|
|
|
|
Returns TRUE if the format of the given data object is available 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.
|
|
|