Removed Aqua style from docs.

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

diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex
index 9c6bb2eb95aaad9a5054687adf25705e7de94745..9b9825c01aa078658787827b6071f7c66026e38c 100644 (file)
--- a/docs/latex/wx/clipbrd.tex
+++ b/docs/latex/wx/clipbrd.tex
@@ -5,9 +5,11 @@ clipboard class from wxWindows 1.xx, which has the same name but a different imp
 
 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.
 

+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::AddData}{wxclipboardadddata} to put data
-on the clipboard (one or more times), or \helpref{wxClipboard::GetData}{wxclipboardgetdata} to
+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
 the clipboard and relinquish ownership. You should keep the clipboard open only momentarily.
 
 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.
 


@@ -19,18 +21,18 @@ For example:
   {
     // This data objects are held by the clipboard, 
     // so do not delete them in the app.
   {
     // This data objects are held by the clipboard, 
     // so do not delete them in the app.

-    wxTheClipboard->AddData( new wxTextDataObject("Some text") );
+    wxTheClipboard->SetData( new wxTextDataObject("Some text") );

     wxTheClipboard->Close();
   }
 
   // Read some text
   if (wxTheClipboard->Open())
   {
     wxTheClipboard->Close();
   }
 
   // Read some text
   if (wxTheClipboard->Open())
   {

-    wxTextDataObject data;
-    if (wxTheClipboard->IsSupported(data))
+    if (wxTheClipboard->IsSupported( wxDF_TEXT ))

     {
     {

-      wxTheClipboard->GetData(data);
-      wxMessageBox(data.GetText());
+      wxTextDataObject data;
+      wxTheClipboard->GetData( data );
+      wxMessageBox( data.GetText() );

     }  
     wxTheClipboard->Close();
   }
     }  
     wxTheClipboard->Close();
   }


@@ -40,6 +42,10 @@ For example:
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/clipbrd.h>
+

 \wxheading{See also}
 
 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}
 \wxheading{See also}
 
 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}


@@ -62,8 +68,15 @@ Destructor.
 
 \func{bool}{AddData}{\param{wxDataObject*}{ data}}
 
 
 \func{bool}{AddData}{\param{wxDataObject*}{ data}}
 

-Call this function to add a data object to the clipboard. This function can be called several times
-to put different formats on the clipboard.
+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}
 
 
 \membersection{wxClipboard::Clear}\label{wxclipboardclear}
 


@@ -79,14 +92,20 @@ Call this function to close the clipboard, having opened it with \helpref{wxClip
 
 \membersection{wxClipboard::GetData}\label{wxclipboardgetdata}
 
 
 \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.
 
 
 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::IsSupported}\label{wxclipboardissupported}
 
 \membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}
 

-\func{bool}{IsSupported}{\param{wxDataObject&}{ data}}
+\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.
 


@@ -110,3 +129,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}
+
+\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.
+
+