Rename wxGetFileType to wxGetFileKind

[wxWidgets.git] / include / wx / generic / helpext.h

diff --git a/include/wx/generic/helpext.h b/include/wx/generic/helpext.h
index 58ef2bb7bcf242e9482e35b7ad31b9f78b976ed7..b8c50c146a4facf0ce81ece372aca77b05eba0d3 100644 (file)
--- a/include/wx/generic/helpext.h
+++ b/include/wx/generic/helpext.h
@@ -1,7 +1,8 @@
 /*-*- c++ -*-********************************************************
- * helpext.h - an external help controller for wxWindows             *
+ * helpext.h - an external help controller for wxWidgets            *
  *                                                                  *
  * (C) 1998 by Karsten Ballüder (Ballueder@usa.net)                 *
+ * License: wxWindows licence                                       *
  *                                                                  *
  * $Id$
  *******************************************************************/
@@ -32,7 +33,7 @@ class WXDLLIMPEXP_ADV wxExtHelpMapList;
 /// Default browser name.
 #   define WXEXTHELP_DEFAULTBROWSER _T("netscape")
 /// Is default browse a variant of netscape?
-#   define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE TRUE
+#   define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE true
 #endif
 
 /**
@@ -55,7 +56,7 @@ class WXDLLIMPEXP_ADV wxExtHelpMapList;
 */
 
 class WXDLLIMPEXP_ADV wxExtHelpController : public wxHelpControllerBase
-{      
+{
 DECLARE_CLASS(wxExtHelpController)
    public:
    wxExtHelpController();
@@ -65,9 +66,9 @@ DECLARE_CLASS(wxExtHelpController)
        The Netscape support will check whether Netscape is already
        running (by looking at the .netscape/lock file in the user's
        home directory) and tell it to load the page into the existing
-       window. 
+       window.
        @param browsername The command to call a browser/html viewer.
-       @param isNetscape Set this to TRUE if the browser is some variant of Netscape.
+       @param isNetscape Set this to true if the browser is some variant of Netscape.
    */
    // Obsolete form
    void SetBrowser(const wxString & browsername = WXEXTHELP_DEFAULTBROWSER,
@@ -106,7 +107,7 @@ DECLARE_CLASS(wxExtHelpController)
        @file Name of help directory.
        @return true on success
    */
-   virtual bool LoadFile(const wxString& file = wxT(""));
+   virtual bool LoadFile(const wxString& file = wxEmptyString);
 
    /** Display list of all help entries.
        @return true on success
@@ -129,7 +130,8 @@ DECLARE_CLASS(wxExtHelpController)
        @key k string to search for, empty string will list all entries
        @return true on success
    */
-   virtual bool KeywordSearch(const wxString& k);
+   virtual bool KeywordSearch(const wxString& k,
+                              wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
 
    /// does nothing
    virtual bool Quit(void);
@@ -143,11 +145,11 @@ DECLARE_CLASS(wxExtHelpController)
    virtual void SetFrameParameters(const wxString& WXUNUSED(title),
                                    const wxSize& WXUNUSED(size),
                                    const wxPoint& WXUNUSED(pos) = wxDefaultPosition,
-                                   bool WXUNUSED(newFrameEachTime) = FALSE)
+                                   bool WXUNUSED(newFrameEachTime) = false)
       {
          // does nothing by default
       }
-   /// Obtains the latest settings used by the help frame and the help 
+   /// Obtains the latest settings used by the help frame and the help
    /// frame.
    virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
                                    wxPoint *WXUNUSED(pos) = NULL,