Added font setting and ability to determine AUI notebook height for a given page...

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

diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex
index f7799f706ace39c36fa9db9e71f94cd18a945d1c..cba1926fb16a755ae0f120a49f0507c212cd3ea5 100644 (file)
--- 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
 \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.
 
 
 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
 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,18 +52,21 @@ For example:
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

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

 
 \func{}{wxClipboard}{\void}
 
 Constructor.
 
 
 \func{}{wxClipboard}{\void}
 
 Constructor.
 

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

 
 \func{}{\destruct{wxClipboard}}{\void}
 
 Destructor.
 
 
 \func{}{\destruct{wxClipboard}}{\void}
 
 Destructor.
 

+

 \membersection{wxClipboard::AddData}\label{wxclipboardadddata}
 
 \func{bool}{AddData}{\param{wxDataObject*}{ data}}
 \membersection{wxClipboard::AddData}\label{wxclipboardadddata}
 
 \func{bool}{AddData}{\param{wxDataObject*}{ data}}


@@ -78,18 +81,21 @@ the data explicitly.
 
 \helpref{wxClipboard::SetData}{wxclipboardsetdata}
 
 
 \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::Clear}\label{wxclipboardclear}
 
 \func{void}{Clear}{\void}
 
 Clears the global clipboard object and the system's clipboard if possible.
 

+

 \membersection{wxClipboard::Close}\label{wxclipboardclose}
 
 \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}.
 
 
 Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Open}{wxclipboardopen}.
 

+

 \membersection{wxClipboard::Flush}\label{wxclipboardflush}
 
 \func{bool}{Flush}{\void}
 \membersection{wxClipboard::Flush}\label{wxclipboardflush}
 
 \func{bool}{Flush}{\void}


@@ -97,26 +103,38 @@ 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.
 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
 
 \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}
 
 
 \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}}
 
 
 \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::IsUsingPrimarySelection}\label{wxclipboardisusingprimaryselection}
+
+\constfunc{bool}{IsUsingPrimarySelection}{\void}
+
+Returns \true if we are using the primary selection, \false if clipboard one.
+See \helpref{UsePrimarySelection}{wxclipboarduseprimary} for more information.
+

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


@@ -128,7 +146,8 @@ 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}
 


@@ -145,12 +164,21 @@ the data explicitly.
 
 \helpref{wxClipboard::AddData}{wxclipboardadddata}
 
 
 \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,
-if {\it primary} is TRUE.
+On platforms supporting it (all X11-based ports), wxClipboard uses the
+CLIPBOARD X11 selection by default. When this function is called with \true
+argument, all subsequent clipboard operations will use PRIMARY selection until
+this function is called again with \false.

 
 

+On the other platforms, there is no PRIMARY selection and so all clipboard
+operations will fail. This allows to implement the standard X11 handling of the
+clipboard which consists in copying data to the CLIPBOARD selection only when
+the user explicitly requests it (i.e. by selection \texttt{"Copy"} menu
+command) but putting the currently selected text into the PRIMARY selection
+automatically, without overwriting the normal clipboard contents with the
+currently selected text on the other platforms.