Document wxHelpControllerBase so the type can be used in Phoenix

[wxWidgets.git] / interface / wx / html / helpctrl.h

diff --git a/interface/wx/html/helpctrl.h b/interface/wx/html/helpctrl.h
index 3b0803bf0d74fc06a5e99a65240e846aed093b23..0d5bece05998721511aa2e55466c5d47daea250a 100644 (file)
--- a/interface/wx/html/helpctrl.h
+++ b/interface/wx/html/helpctrl.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxHtmlHelpController
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -37,7 +37,7 @@
     @see wxBestHelpController, wxHtmlHelpFrame, wxHtmlHelpDialog,
          wxHtmlHelpWindow, wxHtmlModalHelp
 */
-class wxHtmlHelpController
+class wxHtmlHelpController : public wxHelpControllerBase
 {
 public:
     /**
@@ -79,6 +79,8 @@ public:
     */
     wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE,
                          wxWindow* parentWindow = NULL);
+    wxHtmlHelpController(wxWindow* parentWindow, int style = wxHF_DEFAULT_STYLE);
+
 
     /**
         Adds a book (i.e. a @ref overview_html_helpformats ".hhp file"; an HTML Help
@@ -171,6 +173,21 @@ public:
     virtual void ReadCustomization(wxConfigBase* cfg,
                                    const wxString& path = wxEmptyString);
 
+    /**
+        Sets whether the help frame should prevent application from exiting
+        if it's the only remaining top level window.
+
+        @enable
+            If @true, the application will not quit unless the help frame is
+            closed. Default is @false, i.e. the application does exit if only
+            the help window remains opened.
+
+        @see wxApp::SetExitOnFrameDelete()
+
+        @since 2.9.2
+    */
+    void SetShouldPreventAppExit(bool enable);
+
     /**
         Sets the path for storing temporary files - cached binary versions of index and
         contents files.
@@ -240,7 +257,7 @@ protected:
     @code
         // The help can be browsed during the lifetime of this object; when the
         // user quits the help, program execution will continue.
-        wxHtmlModalHelp help(parent, wxT("help"), wxT("My topic"));
+        wxHtmlModalHelp help(parent, "help", "My topic");
     @endcode
 
     @library{wxhtml}