Some warnings removed.

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

diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex
index c8cefc54b9af20a29fbb79c28d178fe688d4adff..9c6bb2eb95aaad9a5054687adf25705e7de94745 100644 (file)
--- a/docs/latex/wx/clipbrd.tex
+++ b/docs/latex/wx/clipbrd.tex
@@ -3,9 +3,10 @@
 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.
 
 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
-now own the clipboard. Call \helpref{wxClipboard::SetData}{wxclipboardsetdata} to put data
+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
 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.
 on the clipboard (one or more times), 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.


@@ -13,24 +14,25 @@ the clipboard and relinquish ownership. You should keep the clipboard open only
 For example:
 
 \begin{verbatim}
 For example:
 
 \begin{verbatim}

-  wxClipboard clipboard;
-

   // Write some text to the 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->AddData( new wxTextDataObject("Some text") );
+    wxTheClipboard->Close();

   }
 
   // Read some text
   }
 
   // Read some text

-  if (clipboard.Open() && clipboard.IsSupportedFormat(wxDF_TEXT))
+  if (wxTheClipboard->Open())

   {
   {

-    wxTextDataObject object;
-    clipboard.GetData(& object);
-    clipboard.Close();
-
-    wxMessageBox(object.GetText());
+    wxTextDataObject data;
+    if (wxTheClipboard->IsSupported(data))
+    {
+      wxTheClipboard->GetData(data);
+      wxMessageBox(data.GetText());
+    }  
+    wxTheClipboard->Close();

   }
 \end{verbatim}
 
   }
 \end{verbatim}
 


@@ -56,6 +58,13 @@ Constructor.
 
 Destructor.
 
 
 Destructor.
 

+\membersection{wxClipboard::AddData}\label{wxclipboardadddata}
+
+\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.
+

 \membersection{wxClipboard::Clear}\label{wxclipboardclear}
 
 \func{void}{Clear}{\void}
 \membersection{wxClipboard::Clear}\label{wxclipboardclear}
 
 \func{void}{Clear}{\void}


@@ -66,26 +75,20 @@ Clears the global clipboard object and the system's clipboard if possible.
 
 \func{bool}{Close}{\void}
 
 
 \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::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.
-
-\membersection{wxClipboard::IsSupportedFormat}\label{wxclipboardissupportedformat}
-
-\func{bool}{IsSupportedFormat}{\param{wxDataFormat}{ format}, \param{const wxString\&}{ id = ""}}
+format. Returns TRUE on success.

 
 

-Returns TRUE if the given format is available on the clipboard.
+\membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}

 
 

-\wxheading{Parameters}
+\func{bool}{IsSupported}{\param{wxDataObject&}{ data}}

 
 

-\docparam{format}{The format. See \helpref{wxDataObject}{wxdataobject} for a list of formats.}
-
-\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}
 
 
 \membersection{wxClipboard::Open}\label{wxclipboardopen}
 


@@ -97,10 +100,13 @@ 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).
+

 \membersection{wxClipboard::SetData}\label{wxclipboardsetdata}
 
 \func{bool}{SetData}{\param{wxDataObject*}{ data}}
 
 \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.