fix the signature of the documented functions and document some (relatively) new...

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

diff --git a/include/wx/tipdlg.h b/include/wx/tipdlg.h
index 594eb151b4dd4355d441f01ebb3a366ba2cf37fd..7058568f8c548c621bac1f215ad52bdade7495b2 100644 (file)
--- a/include/wx/tipdlg.h
+++ b/include/wx/tipdlg.h
@@ -12,10 +12,6 @@
 #ifndef _WX_TIPDLG_H_
 #define _WX_TIPDLG_H_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "tipdlg.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers which we must include here
 // ----------------------------------------------------------------------------
@@ -36,7 +32,7 @@
 // wxTipProvider evidently needs some internal state which is the tip "index"
 // and which should be saved/restored by the program to not always show one and
 // the same tip (of course, you may use random starting position as well...)
-class WXDLLEXPORT wxTipProvider
+class WXDLLIMPEXP_ADV wxTipProvider
 {
 public:
     wxTipProvider(size_t currentTip) { m_currentTip = currentTip; }
@@ -49,6 +45,11 @@ public:
     // from where to start the next time)
     size_t GetCurrentTip() const { return m_currentTip; }
 
+    // Allows any user-derived class to optionally override this function to
+    // modify the tip as soon as it is read. If return wxEmptyString, then
+    // the tip is skipped, and the next one is read.
+    virtual wxString PreprocessTip(const wxString& tip) { return tip; }
+
     // virtual dtor for the base class
     virtual ~wxTipProvider() { }
 
@@ -60,8 +61,8 @@ protected:
 // specified text file as the source of tips (each line is a tip).
 //
 // NB: the caller is responsible for deleting the pointer!
-WXDLLEXPORT wxTipProvider *wxCreateFileTipProvider(const wxString& filename,
-                                                   size_t currentTip);
+WXDLLIMPEXP_ADV wxTipProvider *wxCreateFileTipProvider(const wxString& filename,
+                                                       size_t currentTip);
 
 // ----------------------------------------------------------------------------
 // wxTipDialog
@@ -73,10 +74,10 @@ WXDLLEXPORT wxTipProvider *wxCreateFileTipProvider(const wxString& filename,
 // the user to disable this (however, it's the program which should show, or
 // not, the dialog on startup depending on its value, not this class).
 //
-// The function returns TRUE if this checkbox is checked, FALSE otherwise.
-WXDLLEXPORT bool wxShowTip(wxWindow *parent,
-                           wxTipProvider *tipProvider,
-                           bool showAtStartup = TRUE);
+// The function returns true if this checkbox is checked, false otherwise.
+WXDLLIMPEXP_ADV bool wxShowTip(wxWindow *parent,
+                               wxTipProvider *tipProvider,
+                               bool showAtStartup = true);
 
 #endif // wxUSE_STARTUP_TIPS