Fix wrong use of EVT_COMMAND in the example in wxThread documentation.

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

diff --git a/interface/wx/html/helpdlg.h b/interface/wx/html/helpdlg.h
index 185e4c6a309ac4753e230b163e5a44cc3e6156b2..f121301e41890fc4c78d668e1ba69d91507fac6a 100644 (file)
--- a/interface/wx/html/helpdlg.h
+++ b/interface/wx/html/helpdlg.h
@@ -3,45 +3,45 @@
 // Purpose:     interface of wxHtmlHelpDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxHtmlHelpDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxHtmlHelpDialog
 
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxHtmlHelpDialog
 

-    This class is used by wxHtmlHelpController
-    to display help.
+    This class is used by wxHtmlHelpController to display help.

     It is an internal class and should not be used directly - except for the case
     when you're writing your own HTML help controller.
 
     @library{wxhtml}
     It is an internal class and should not be used directly - except for the case
     when you're writing your own HTML help controller.
 
     @library{wxhtml}

-    @category{FIXME}
+    @category{help,html}

 */
 */

-class wxHtmlHelpDialog : public wxFrame
+class wxHtmlHelpDialog : public wxDialog

 {
 public:
 {
 public:

-    //@{
+    wxHtmlHelpDialog(wxHtmlHelpData* data = NULL);
+

     /**
     /**

-        Constructor. For the values of @e style, please see the documentation for
-        wxHtmlHelpController.
+        Constructor.
+
+        For the possible values of @a style, please see wxHtmlHelpController.

     */
     */

-    wxHtmlHelpDialog(wxHtmlHelpData* data = NULL);
-    wxHtmlHelpDialog(wxWindow* parent, int wxWindowID,
+    wxHtmlHelpDialog(wxWindow* parent, wxWindowID id,

                      const wxString& title = wxEmptyString,
                      int style = wxHF_DEFAULT_STYLE,
                      wxHtmlHelpData* data = NULL);
                      const wxString& title = wxEmptyString,
                      int style = wxHF_DEFAULT_STYLE,
                      wxHtmlHelpData* data = NULL);

-    //@}

 
     /**
         You may override this virtual method to add more buttons to the help window's
         toolbar. @a toolBar is a pointer to the toolbar and @a style is the style
 
     /**
         You may override this virtual method to add more buttons to the help window's
         toolbar. @a toolBar is a pointer to the toolbar and @a style is the style

-        flag as passed to the Create method.
+        flag as passed to the Create() method.
+

         wxToolBar::Realize is called immediately after returning from this function.
     */
     virtual void AddToolbarButtons(wxToolBar* toolBar, int style);
 
     /**
         wxToolBar::Realize is called immediately after returning from this function.
     */
     virtual void AddToolbarButtons(wxToolBar* toolBar, int style);
 
     /**

-        Creates the dialog. See @ref wxhtmlhelpdialog() "the constructor"
+        Creates the dialog. See @ref wxHtmlHelpDialog() "the constructor"

         for a description of the parameters.
     */
     bool Create(wxWindow* parent, wxWindowID id,
         for a description of the parameters.
     */
     bool Create(wxWindow* parent, wxWindowID id,


@@ -53,29 +53,16 @@ public:
     */
     wxHtmlHelpController* GetController() const;
 
     */
     wxHtmlHelpController* GetController() const;
 

-    /**
-        Reads the user's settings for this dialog see
-        wxHtmlHelpController::ReadCustomization)
-    */
-    void ReadCustomization(wxConfigBase* cfg,
-                           const wxString& path = wxEmptyString);
-

     /**
         Sets the help controller associated with the dialog.
     */
     /**
         Sets the help controller associated with the dialog.
     */

-    void SetController(wxHtmlHelpController* contoller);
+    void SetController(wxHtmlHelpController* controller);

 
     /**
 
     /**

-        Sets the dialog's title format. @a format must contain exactly one "%s"
-        (it will be replaced by the page title).
-    */
-    void SetTitleFormat(const wxString& format);
+        Sets the dialog's title format.

 
 

-    /**
-        Saves the user's settings for this dialog (see
-        wxHtmlHelpController::WriteCustomization).
+        @a format must contain exactly one "%s" (it will be replaced by the page title).

     */
     */

-    void WriteCustomization(wxConfigBase* cfg,
-                            const wxString& path = wxEmptyString);
+    void SetTitleFormat(const wxString& format);

 };
 
 };