Prep for wxPython 2.1b3 release

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

diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex
index 9c6bb2eb95aaad9a5054687adf25705e7de94745..e9b3352026004c561a4a2df21fde406d9c7e90ca 100644 (file)
--- a/docs/latex/wx/clipbrd.tex
+++ b/docs/latex/wx/clipbrd.tex
@@ -26,11 +26,11 @@ For example:
   // Read some text
   if (wxTheClipboard->Open())
   {
-    wxTextDataObject data;
-    if (wxTheClipboard->IsSupported(data))
+    if (wxTheClipboard->IsSupported( "STRING" ))
     {
-      wxTheClipboard->GetData(data);
-      wxMessageBox(data.GetText());
+      wxTextDataObject data;
+      wxTheClipboard->GetData( &data );
+      wxMessageBox( data.GetText() );
     }  
     wxTheClipboard->Close();
   }
@@ -40,6 +40,10 @@ For example:
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/clipbrd.h>
+
 \wxheading{See also}
 
 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}
@@ -79,14 +83,14 @@ Call this function to close the clipboard, having opened it with \helpref{wxClip
 
 \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. Returns TRUE on success.
 
 \membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}
 
-\func{bool}{IsSupported}{\param{wxDataObject&}{ data}}
+\func{bool}{IsSupported}{\param{wxDataFormat}{ format}}
 
 Returns TRUE if the format of the given data object is available on the clipboard.
 
@@ -110,3 +114,12 @@ 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.
 
+\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.
+
+