Clarify documentation for wxPropertyGridEvent::GetProperty()

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

diff --git a/include/wx/tipdlg.h b/include/wx/tipdlg.h
index a9003851bde9cf58355b9d30c533192f6f9ae6ad..5f5ecc6c305775959264ff95c055333ec3f3dd4f 100644 (file)
--- a/include/wx/tipdlg.h
+++ b/include/wx/tipdlg.h
@@ -6,16 +6,12 @@
 // Created:     28.06.99
 // RCS-ID:      $Id$
 // Copyright:   (c) Vadim Zeitlin
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TIPDLG_H_
 #define _WX_TIPDLG_H_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "tipdlg.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers which we must include here
 // ----------------------------------------------------------------------------
@@ -43,14 +39,14 @@ public:
 
     // get the current tip and update the internal state to return the next tip
     // when called for the next time
-    virtual wxString GetTip() = 0;  
+    virtual wxString GetTip() = 0;
 
     // get the current tip "index" (or whatever allows the tip provider to know
     // 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 
+    // 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; }
 
@@ -65,8 +61,10 @@ protected:
 // specified text file as the source of tips (each line is a tip).
 //
 // NB: the caller is responsible for deleting the pointer!
+#if wxUSE_TEXTFILE
 WXDLLIMPEXP_ADV wxTipProvider *wxCreateFileTipProvider(const wxString& filename,
                                                        size_t currentTip);
+#endif // wxUSE_TEXTFILE
 
 // ----------------------------------------------------------------------------
 // wxTipDialog
@@ -78,10 +76,10 @@ WXDLLIMPEXP_ADV 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.
+// The function returns true if this checkbox is checked, false otherwise.
 WXDLLIMPEXP_ADV bool wxShowTip(wxWindow *parent,
                                wxTipProvider *tipProvider,
-                               bool showAtStartup = TRUE);
+                               bool showAtStartup = true);
 
 #endif // wxUSE_STARTUP_TIPS