documenting events that are not available on OSX, closes #10776

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

diff --git a/interface/wx/html/helpctrl.h b/interface/wx/html/helpctrl.h
index 006cc238c53bed137d42dc41fb1531637387b9c8..50e51989a09a3a8c869af3ee6843af93c4a097c1 100644 (file)
--- a/interface/wx/html/helpctrl.h
+++ b/interface/wx/html/helpctrl.h
@@ -101,7 +101,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 +115,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 +133,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 +168,8 @@ 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 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 +208,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 +240,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}