Add documentation of wxFileSelectorEx() and wx{Load,Save}FileSelector().

[wxWidgets.git] / interface / wx / tipdlg.h

diff --git a/interface/wx/tipdlg.h b/interface/wx/tipdlg.h
index 10bd26ccdc720d62be0d068beddd4ba3f6d1655c..a7e0d49f7d356721777654f62554d05546d91101 100644 (file)
--- a/interface/wx/tipdlg.h
+++ b/interface/wx/tipdlg.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxTipProvider
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxTipProvider
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -19,9 +19,9 @@
     use it instead of the one returned by wxCreateFileTipProvider().
 
     @library{wxadv}
     use it instead of the one returned by wxCreateFileTipProvider().
 
     @library{wxadv}

-    @category{FIXME}
+    @category{misc}

 
 

-    @see @ref overview_tipsoverview "Startup tips overview", ::wxShowTip
+    @see @ref overview_tips, ::wxShowTip

 */
 class wxTipProvider
 {
 */
 class wxTipProvider
 {


@@ -35,26 +35,27 @@ public:
     wxTipProvider(size_t currentTip);
 
     /**
     wxTipProvider(size_t currentTip);
 
     /**

-        Returns the index of the current tip (i.e. the one which would be returned by
-        GetTip).
+        Returns the index of the current tip (i.e. the one which would be returned by GetTip()).
+

         The program usually remembers the value returned by this function after calling
         The program usually remembers the value returned by this function after calling

-        wxShowTip(). Note that it is not the same as the value which
-        was passed to wxShowTip + 1 because the user might have pressed the "Next"
-        button in the tip dialog.
+        wxShowTip(). Note that it is not the same as the value which was passed to
+        wxShowTip + 1 because the user might have pressed the "Next" button in
+        the tip dialog.

     */
     size_t GetCurrentTip() const;
 
     /**
     */
     size_t GetCurrentTip() const;
 
     /**

-        Return the text of the current tip and pass to the next one. This function is
-        pure virtual, it should be implemented in the derived classes.
+        Return the text of the current tip and pass to the next one.
+        This function is pure virtual, it should be implemented in the derived classes.

     */
     */

-    wxString GetTip();
+    virtual wxString GetTip() = 0;

 
     /**
 
     /**

-        Returns a modified tip. This function will be called immediately after read,
-        and before being check whether it is a comment, an empty string or a string
-        to translate. You can optionally override this in your custom user-derived
-        class
+        Returns a modified tip.
+
+        This function will be called immediately after read, and before being check
+        whether it is a comment, an empty string or a string to translate.
+        You can optionally override this in your custom user-derived class

         to optionally to modify the tip as soon as it is read. You can return any
         modification to the string. If you return wxEmptyString, then this tip is
         skipped, and the next one is read.
         to optionally to modify the tip as soon as it is read. You can return any
         modification to the string. If you return wxEmptyString, then this tip is
         skipped, and the next one is read.


@@ -68,7 +69,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_dialog */
+/** @addtogroup group_funcmacro_dialog */

 //@{
 
 /**
 //@{
 
 /**