Fix wrong wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK name in the docs.

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

diff --git a/interface/wx/help.h b/interface/wx/help.h
index adfc80278418a29d80488fa7f8c41a159ade9daf..85d616c60e8cfc3bd0e82f05e8c719c5abe4ffa0 100644 (file)
--- a/interface/wx/help.h
+++ b/interface/wx/help.h
@@ -3,9 +3,18 @@
 // Purpose:     interface of wxHelpController
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+/**
+    Help search modes for wxHelpController::KeywordSearch().
+ */
+enum wxHelpSearchMode
+{
+    wxHELP_SEARCH_INDEX,    ///< Search the index only.
+    wxHELP_SEARCH_ALL       ///< Search all entries.
+};
+
 /**
     @class wxHelpController
 
@@ -38,10 +47,10 @@
     The following help controller classes are defined:
     - wxWinHelpController, for controlling Windows Help.
     - wxCHMHelpController, for controlling MS HTML Help. To use this, you need to
-      set wxUSE_MS_HTML_HELP to 1 in setup.h and have htmlhelp.h header from
-      Microsoft's HTML Help kit (you don't need VC++ specific htmlhelp.lib
+      set wxUSE_MS_HTML_HELP to 1 in setup.h and have the htmlhelp.h header from
+      Microsoft's HTML Help kit. (You don't need the VC++-specific htmlhelp.lib
       because wxWidgets loads necessary DLL at runtime and so it works with all
-      compilers).
+      compilers.)
     - wxBestHelpController, for controlling MS HTML Help or, if Microsoft's runtime
       is not available, wxHtmlHelpController. You need to provide @b both CHM and
       HTB versions of the help file. For wxMSW only.
@@ -153,8 +162,8 @@ public:
         @param newFrameEachTime
             @true if a new frame is drawn with each invocation.
     */
-    virtual wxFrame* GetFrameParameters(const wxSize* size = NULL,
-                                        const wxPoint* pos = NULL,
+    virtual wxFrame* GetFrameParameters(wxSize* size = NULL,
+                                        wxPoint* pos = NULL,
                                         bool* newFrameEachTime = NULL);
 
     /**
@@ -182,8 +191,8 @@ public:
     /**
         If the help viewer is not running, runs it, and searches for sections matching
         the given keyword. If one match is found, the file is displayed at this section.
-        The optional parameter allows the search the index (wxHELP_SEARCH_INDEX)
-        but this currently only supported by the wxHtmlHelpController.
+        The optional parameter allows to search the index (wxHELP_SEARCH_INDEX)
+        but this currently is only supported by the wxHtmlHelpController.
 
         - @e WinHelp, MS HTML Help:
           If more than one match is found, the first topic is displayed.
@@ -205,13 +214,13 @@ public:
 
         wxHtmlHelpController ignores this call.
     */
-    virtual bool LoadFile(const wxString& file = "");
+    virtual bool LoadFile(const wxString& file = wxEmptyString);
 
     /**
         Overridable member called when this application's viewer is quit by the user.
         This does not work for all help controllers.
     */
-    virtual bool OnQuit();
+    virtual void OnQuit();
 
     /**
         If the viewer is running, quits it by disconnecting.
@@ -220,7 +229,7 @@ public:
     virtual bool Quit();
 
     /**
-        For wxHtmlHelpController, the title is set (again with %s indicating the
+        For wxHtmlHelpController, the title is set (with %s indicating the
         page title) and also the size and position of the frame if the frame is
         already open. @a newFrameEachTime is ignored.