added test of focusing/selecting another item

[wxWidgets.git] / interface / clipboard.h

diff --git a/interface/clipboard.h b/interface/clipboard.h
index 75f334ae75ff974957f5a12ee7484f86dca2a2db..5bdd0038ac2ab3768cedf972ad7188126ace7c24 100644 (file)
--- a/interface/clipboard.h
+++ b/interface/clipboard.h
@@ -1,34 +1,31 @@
 /////////////////////////////////////////////////////////////////////////////
-    // Name:        clipboard.h
-    // Purpose:     documentation for global functions
-    // Author:      wxWidgets team
-    // RCS-ID:      $Id$
-    // Licence:     wxWindows license
-    /////////////////////////////////////////////////////////////////////////////
-    
-    /**
-    Gets the name of a registered clipboard format, and puts it into the buffer @e
-    formatName which is of maximum
-    length @e maxCount. @e dataFormat must not specify a predefined clipboard
-    format.
+// Name:        clipboard.h
+// Purpose:     interface of global functions
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+Gets the name of a registered clipboard format, and puts it into the buffer @a
+formatName which is of maximum
+length @e maxCount. @a dataFormat must not specify a predefined clipboard
+format.
 */
 bool wxGetClipboardFormatName(int dataFormat,
                               const wxString& formatName,
                               int maxCount);
 
 
-    /**
-    Gets data from the clipboard.
-    
-    @e dataFormat may be one of:
-    
-     wxCF_TEXT or wxCF_OEMTEXT: returns a pointer to new memory containing a
-    null-terminated text string.
-     wxCF_BITMAP: returns a new wxBitmap.
-    
-    The clipboard must have previously been opened for this call to succeed.
+/**
+Gets data from the clipboard.
+@a dataFormat may be one of:
+ wxCF_TEXT or wxCF_OEMTEXT: returns a pointer to new memory containing a
+null-terminated text string.
+ wxCF_BITMAP: returns a new wxBitmap.
+The clipboard must have previously been opened for this call to succeed.
 */
-wxObject * wxGetClipboardData(int dataFormat);
+wxObject* wxGetClipboardData(int dataFormat);
 
 /**
     Returns @true if the given data format is available on the clipboard.
@@ -65,15 +62,12 @@ bool wxCloseClipboard();
     to the clipboard. Each call to this  function specifies a known
     available format; the function returns the format that appears next in
     the list.
-    
-    @e dataFormat specifies a known format. If this parameter is zero,
+    @a dataFormat specifies a known format. If this parameter is zero,
     the function returns the first format in the list.
-    
     The return value specifies the next known clipboard data format if the
-    function is successful. It is zero if the @e dataFormat parameter specifies
+    function is successful. It is zero if the @a dataFormat parameter specifies
     the last  format in the list of available formats, or if the clipboard
     is not open.
-    
     Before it enumerates the formats function, an application must open the
     clipboard by using the
     wxOpenClipboard function.