mention Watcom makefile for wxBase

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

diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex
index 38f873a6b3fc28c086d538ef4c0696c6378b6c2f..7789b647884b96fc5f4146a1e842ad426aab4aee 100644 (file)
--- a/docs/latex/wx/clipbrd.tex
+++ b/docs/latex/wx/clipbrd.tex
@@ -7,7 +7,7 @@ To use the clipboard, you call member functions of the global {\bf wxTheClipboar
 
 See also the \helpref{wxDataObject overview}{wxdataobjectoverview} for further information.
 
 
 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
 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


@@ -64,6 +64,20 @@ Constructor.
 
 Destructor.
 
 
 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}
 \membersection{wxClipboard::Clear}\label{wxclipboardclear}
 
 \func{void}{Clear}{\void}


@@ -76,18 +90,33 @@ Clears the global clipboard object and the system's clipboard if possible.
 
 Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Open}{wxclipboardopen}.
 
 
 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 unsuccesful 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
 \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.

 
 \membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}
 
 \func{bool}{IsSupported}{\param{const wxDataFormat\&}{ format}}
 
 
 \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 the format of the given data object is available on the clipboard.

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


@@ -99,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.
 
 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}
 
 
 \membersection{wxClipboard::SetData}\label{wxclipboardsetdata}
 


@@ -109,12 +138,19 @@ 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.
 
 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}
 
 \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,
 
 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.