X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dface61ccba162c922b25d18aca2ebc4e6f03312..0532a2588121690115f4629cdcbc41d2049e50c0:/docs/latex/wx/clipbrd.tex

diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex
index c8cefc54b9..f7799f706a 100644
--- a/docs/latex/wx/clipbrd.tex
+++ b/docs/latex/wx/clipbrd.tex
@@ -3,34 +3,38 @@
 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.
 
-To use the clipboard, construct a wxClipboard object on the stack and 
-call \helpref{wxClipboard::Open}{wxclipboardopen}. If this operation returns TRUE, you
+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 (one or more times), or \helpref{wxClipboard::GetData}{wxclipboardgetdata} to
+on the clipboard, or \helpref{wxClipboard::GetData}{wxclipboardgetdata} to
 retrieve data from the clipboard. Call \helpref{wxClipboard::Close}{wxclipboardclose} to close
 the clipboard and relinquish ownership. You should keep the clipboard open only momentarily.
 
 For example:
 
 \begin{verbatim}
-  wxClipboard clipboard;
-
   // Write some text to the clipboard
-  if (clipboard.Open())
+  if (wxTheClipboard->Open())
   {
-    wxTextDataObject object("Some text");
-    clipboard.SetData(& object);
-    clipboard.Close();
+    // This data objects are held by the clipboard, 
+    // so do not delete them in the app.
+    wxTheClipboard->SetData( new wxTextDataObject("Some text") );
+    wxTheClipboard->Close();
   }
 
   // Read some text
-  if (clipboard.Open() && clipboard.IsSupportedFormat(wxDF_TEXT))
+  if (wxTheClipboard->Open())
   {
-    wxTextDataObject object;
-    clipboard.GetData(& object);
-    clipboard.Close();
-
-    wxMessageBox(object.GetText());
+    if (wxTheClipboard->IsSupported( wxDF_TEXT ))
+    {
+      wxTextDataObject data;
+      wxTheClipboard->GetData( data );
+      wxMessageBox( data.GetText() );
+    }  
+    wxTheClipboard->Close();
   }
 \end{verbatim}
 
@@ -38,6 +42,10 @@ For example:
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/clipbrd.h>
+
 \wxheading{See also}
 
 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}
@@ -56,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}
@@ -66,26 +88,35 @@ Clears the global clipboard object and the system's clipboard if possible.
 
 \func{bool}{Close}{\void}
 
-Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Close}{wxclipboardclose}.
+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}}
+\func{bool}{GetData}{\param{wxDataObject\&}{ data}}
 
 Call this function to fill {\it data} with data on the clipboard, if available in the required
-format.
+format. Returns TRUE on success.
 
-\membersection{wxClipboard::IsSupportedFormat}\label{wxclipboardissupportedformat}
+\membersection{wxClipboard::IsOpened}\label{wxclipboardisopened}
 
-\func{bool}{IsSupportedFormat}{\param{wxDataFormat}{ format}, \param{const wxString\&}{ id = ""}}
+\constfunc{bool}{IsOpened}{\void}
 
-Returns TRUE if the given format is available on the clipboard.
+Returns TRUE if the clipboard has been opened.
 
-\wxheading{Parameters}
+\membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}
 
-\docparam{format}{The format. See \helpref{wxDataObject}{wxdataobject} for a list of formats.}
+\func{bool}{IsSupported}{\param{const wxDataFormat\&}{ format}}
 
-\docparam{id}{ If {\it format} is wxDF\_PRIVATE, {\it id} is the identifier of the private data format.}
+Returns TRUE if the format of the given data object is available on the clipboard.
 
 \membersection{wxClipboard::Open}\label{wxclipboardopen}
 
@@ -97,10 +128,29 @@ 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).
+
 \membersection{wxClipboard::SetData}\label{wxclipboardsetdata}
 
 \func{bool}{SetData}{\param{wxDataObject*}{ data}}
 
-Call this function to set a data object to the clipboard. This function can be called several times
-to put different formats on the clipboard.
+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}}
+
+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.
+
 
