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 e32617b3208f4aa2ce29a41bea17015416bd27a1..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$
 // 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
 
 /**
     @class wxHelpController
 


@@ -153,8 +162,8 @@ public:
         @param newFrameEachTime
             @true if a new frame is drawn with each invocation.
     */
         @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);
 
     /**
                                         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.
     /**
         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.
 
         - @e WinHelp, MS HTML Help:
           If more than one match is found, the first topic is displayed.


@@ -208,10 +217,10 @@ public:
     virtual bool LoadFile(const wxString& file = wxEmptyString);
 
     /**
     virtual bool LoadFile(const wxString& file = wxEmptyString);
 
     /**

-        Overrideable member called when this application's viewer is quit by the user.
+        Overridable member called when this application's viewer is quit by the user.

         This does not work for all help controllers.
     */
         This does not work for all help controllers.
     */

-    virtual bool OnQuit();
+    virtual void OnQuit();

 
     /**
         If the viewer is running, quits it by disconnecting.
 
     /**
         If the viewer is running, quits it by disconnecting.