X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc9c7c09bd464f9d0685df1660a3a810ce4cf5dc..7946d7deaac081a745dc616a5eb13ae864865fa2:/docs/latex/wx/clipbrd.tex?ds=sidebyside diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex index caa772f53b..9b9825c01a 100644 --- a/docs/latex/wx/clipbrd.tex +++ b/docs/latex/wx/clipbrd.tex @@ -5,6 +5,8 @@ clipboard class from wxWindows 1.xx, which has the same name but a different imp 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 @@ -19,7 +21,7 @@ For example: { // This data objects are held by the clipboard, // so do not delete them in the app. - wxTheClipboard->AddData( new wxTextDataObject("Some text") ); + wxTheClipboard->SetData( new wxTextDataObject("Some text") ); wxTheClipboard->Close(); } @@ -62,6 +64,20 @@ Constructor. 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} @@ -81,6 +97,12 @@ Call this function to close the clipboard, having opened it with \helpref{wxClip 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}} @@ -107,6 +129,13 @@ 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}}