X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/741ed1143d29aea62cd8b983ebf3af782dd45200..5c35d5c1d984f46d33e8181c907936e96160d795:/docs/latex/wx/clipbrd.tex?ds=inline diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex index f7799f706a..a216479e01 100644 --- a/docs/latex/wx/clipbrd.tex +++ b/docs/latex/wx/clipbrd.tex @@ -1,13 +1,13 @@ \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. +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 +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 @@ -52,13 +52,13 @@ For example: \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxClipboard::wxClipboard} +\membersection{wxClipboard::wxClipboard}\label{wxclipboardctor} \func{}{wxClipboard}{\void} Constructor. -\membersection{wxClipboard::\destruct{wxClipboard}} +\membersection{wxClipboard::\destruct{wxClipboard}}\label{wxclipboarddtor} \func{}{\destruct{wxClipboard}}{\void} @@ -86,7 +86,7 @@ Clears the global clipboard object and the system's clipboard if possible. \membersection{wxClipboard::Close}\label{wxclipboardclose} -\func{bool}{Close}{\void} +\func{void}{Close}{\void} Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Open}{wxclipboardopen}. @@ -97,26 +97,26 @@ Call this function to close the clipboard, having opened it with \helpref{wxClip 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 unsuccesful for any reason. +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. +format. Returns true on success. \membersection{wxClipboard::IsOpened}\label{wxclipboardisopened} \constfunc{bool}{IsOpened}{\void} -Returns TRUE if the clipboard has been opened. +Returns true if the clipboard has been opened. \membersection{wxClipboard::IsSupported}\label{wxclipboardissupported} \func{bool}{IsSupported}{\param{const wxDataFormat\&}{ format}} -Returns TRUE if the format of the given data object is available on the clipboard. +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} @@ -128,7 +128,7 @@ 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). +Returns true on success. This should be tested (as in the sample shown above). \membersection{wxClipboard::SetData}\label{wxclipboardsetdata} @@ -147,10 +147,10 @@ the data explicitly. \membersection{wxClipboard::UsePrimarySelection}\label{wxclipboarduseprimary} -\func{void}{UsePrimarySelection}{\param{bool}{ primary = TRUE}} +\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. +if {\it primary} is true.