patch 1306473

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

diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex
index 151509e42d1c0de6334e73085a4cd97f87505b91..a216479e018081c9fc45bedf2bb07b0794c47b64 100644 (file)
--- a/docs/latex/wx/clipbrd.tex
+++ b/docs/latex/wx/clipbrd.tex
@@ -1,13 +1,15 @@
 \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.
 

-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
+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, 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,17 +21,17 @@ 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())
   {

-    if (wxTheClipboard->IsSupported( "STRING" ))
+    if (wxTheClipboard->IsSupported( wxDF_TEXT ))

     {
       wxTextDataObject data;
     {
       wxTextDataObject data;

-      wxTheClipboard->GetData( &data );
+      wxTheClipboard->GetData( data );

       wxMessageBox( data.GetText() );
     }  
     wxTheClipboard->Close();
       wxMessageBox( data.GetText() );
     }  
     wxTheClipboard->Close();


@@ -50,13 +52,13 @@ 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}
 
 
 \func{}{\destruct{wxClipboard}}{\void}
 


@@ -66,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}
 


@@ -77,22 +86,37 @@ 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}
+
+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 unsuccessful for any reason.
+

 \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
 
 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}
+
+Returns true if the clipboard has been opened.

 
 \membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}
 
 
 \membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}
 

-\func{bool}{IsSupported}{\param{wxDataFormat}{ format}}
+\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::Open}\label{wxclipboardopen}
 
 
 \membersection{wxClipboard::Open}\label{wxclipboardopen}
 


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


@@ -114,12 +138,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.
 

-\membersection{wxClipboard::UsePrimarySelection}\label{wxclipboaruseprimary}
+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}
+\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,
 
 On platforms supporting it (currently only GTK), selects the so called
 PRIMARY SELECTION as the clipboard as opposed to the normal clipboard,

-if primary is TRUE.
+if {\it primary} is true.