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 006cc238c53bed137d42dc41fb1531637387b9c8..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$
 // 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
 */
     @see wxBestHelpController, wxHtmlHelpFrame, wxHtmlHelpDialog,
          wxHtmlHelpWindow, wxHtmlModalHelp
 */

-class wxHtmlHelpController
+class wxHtmlHelpController : public wxHelpControllerBase

 {
 public:
     /**
 {
 public:
     /**


@@ -79,6 +79,8 @@ public:
     */
     wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE,
                          wxWindow* parentWindow = NULL);
     */
     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
 
     /**
         Adds a book (i.e. a @ref overview_html_helpformats ".hhp file"; an HTML Help


@@ -101,7 +103,7 @@ public:
         @param showWaitMsg
             If @true then a decoration-less window with progress message is displayed.
     */
         @param showWaitMsg
             If @true then a decoration-less window with progress message is displayed.
     */

-    bool AddBook(const wxFileName& bookFile, bool showWaitMsg);
+    bool AddBook(const wxFileName& bookFile, bool showWaitMsg = false);

 
     /**
         Adds a book (i.e. a @ref overview_html_helpformats ".hhp file"; an HTML Help
 
     /**
         Adds a book (i.e. a @ref overview_html_helpformats ".hhp file"; an HTML Help


@@ -115,19 +117,7 @@ public:
         @param showWaitMsg
             If @true then a decoration-less window with progress message is displayed.
     */
         @param showWaitMsg
             If @true then a decoration-less window with progress message is displayed.
     */

-    bool AddBook(const wxString& bookUrl, bool showWaitMsg);
-
-    /**
-        This protected virtual method may be overridden so that when specifying the
-        @c wxHF_DIALOG style, the controller uses a different dialog.
-    */
-    virtual wxHtmlHelpDialog* CreateHelpDialog(wxHtmlHelpData* data);
-
-    /**
-        This protected virtual method may be overridden so that the controller
-        uses a different frame.
-    */
-    virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData* data);
+    bool AddBook(const wxString& bookUrl, bool showWaitMsg = false);

 
     /**
         Displays page @a x.
 
     /**
         Displays page @a x.


@@ -145,24 +135,24 @@ public:
         -# try to find x in index (if x is for example "How To ...")
         -# switch to Search panel and start searching
     */
         -# try to find x in index (if x is for example "How To ...")
         -# switch to Search panel and start searching
     */

-    void Display(const wxString& x);
+    bool Display(const wxString& x);

 
     /**
         @overload
 
         This alternative form is used to search help contents by numeric IDs.
     */
 
     /**
         @overload
 
         This alternative form is used to search help contents by numeric IDs.
     */

-    void Display(const int id);
+    bool Display(int id);

 
     /**
         Displays help window and focuses contents panel.
     */
 
     /**
         Displays help window and focuses contents panel.
     */

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

 
     /**
         Displays help window and focuses index panel.
     */
 
     /**
         Displays help window and focuses index panel.
     */

-    void DisplayIndex();
+    bool DisplayIndex();

 
     /**
         Displays the help window, focuses search panel and starts searching.
 
     /**
         Displays the help window, focuses search panel and starts searching.


@@ -180,8 +170,23 @@ public:
     /**
         Reads the controller's setting (position of window, etc.)
     */
     /**
         Reads the controller's setting (position of window, etc.)
     */

-    void ReadCustomization(wxConfigBase* cfg,
-                           wxString path = wxEmptyString);
+    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
 
     /**
         Sets the path for storing temporary files - cached binary versions of index and


@@ -220,8 +225,22 @@ public:
     /**
         Stores controllers setting (position of window etc.)
     */
     /**
         Stores controllers setting (position of window etc.)
     */

-    void WriteCustomization(wxConfigBase* cfg,
-                            wxString path = wxEmptyString);
+    virtual void WriteCustomization(wxConfigBase* cfg,
+                                    const wxString& path = wxEmptyString);
+
+protected:
+
+    /**
+        This protected virtual method may be overridden so that when specifying the
+        @c wxHF_DIALOG style, the controller uses a different dialog.
+    */
+    virtual wxHtmlHelpDialog* CreateHelpDialog(wxHtmlHelpData* data);
+
+    /**
+        This protected virtual method may be overridden so that the controller
+        uses a different frame.
+    */
+    virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData* data);

 };
 
 
 };
 
 


@@ -238,7 +257,7 @@ public:
     @code
         // The help can be browsed during the lifetime of this object; when the
         // user quits the help, program execution will continue.
     @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}
     @endcode
 
     @library{wxhtml}