Added periods

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

diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex
index 7789b647884b96fc5f4146a1e842ad426aab4aee..4197118b286e2ed32c6f46a175cd8a91327e2f9c 100644 (file)
--- a/docs/latex/wx/clipbrd.tex
+++ b/docs/latex/wx/clipbrd.tex
@@ -1,7 +1,7 @@
 \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.
 
 
 To use the clipboard, you call member functions of the global {\bf wxTheClipboard} object.
 


@@ -46,24 +46,31 @@ For example:
 
 <wx/clipbrd.h>
 
 
 <wx/clipbrd.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \wxheading{See also}
 
 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}
 
 \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 +85,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,7 +107,8 @@ 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}
 
 
 \membersection{wxClipboard::GetData}\label{wxclipboardgetdata}
 


@@ -106,17 +117,28 @@ Returns false if the operation is unsuccesful for any reason.
 Call this function to fill {\it data} with data on the clipboard, if available in the required
 format. Returns true on success.
 
 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::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 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}
 


@@ -130,6 +152,7 @@ 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}
 
 \func{bool}{SetData}{\param{wxDataObject*}{ data}}
 \membersection{wxClipboard::SetData}\label{wxclipboardsetdata}
 
 \func{bool}{SetData}{\param{wxDataObject*}{ data}}


@@ -145,12 +168,21 @@ the data explicitly.
 
 \helpref{wxClipboard::AddData}{wxclipboardadddata}
 
 
 \helpref{wxClipboard::AddData}{wxclipboardadddata}
 

+

 \membersection{wxClipboard::UsePrimarySelection}\label{wxclipboarduseprimary}
 
 \func{void}{UsePrimarySelection}{\param{bool}{ primary = true}}
 
 \membersection{wxClipboard::UsePrimarySelection}\label{wxclipboarduseprimary}
 
 \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.