X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..e4097f77c440b1f31a80fe273cc732c14d606096:/interface/wx/html/helpfrm.h

diff --git a/interface/wx/html/helpfrm.h b/interface/wx/html/helpfrm.h
index 4bb71f9cd2..2c358af47e 100644
--- a/interface/wx/html/helpfrm.h
+++ b/interface/wx/html/helpfrm.h
@@ -2,80 +2,87 @@
 // Name:        html/helpfrm.h
 // Purpose:     interface of wxHtmlHelpFrame
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+/// style flags for the Help Frame
+#define wxHF_TOOLBAR                0x0001
+#define wxHF_CONTENTS               0x0002
+#define wxHF_INDEX                  0x0004
+#define wxHF_SEARCH                 0x0008
+#define wxHF_BOOKMARKS              0x0010
+#define wxHF_OPEN_FILES             0x0020
+#define wxHF_PRINT                  0x0040
+#define wxHF_FLAT_TOOLBAR           0x0080
+#define wxHF_MERGE_BOOKS            0x0100
+#define wxHF_ICONS_BOOK             0x0200
+#define wxHF_ICONS_BOOK_CHAPTER     0x0400
+#define wxHF_ICONS_FOLDER           0x0000 // this is 0 since it is default
+#define wxHF_DEFAULT_STYLE          (wxHF_TOOLBAR | wxHF_CONTENTS | \
+                                     wxHF_INDEX | wxHF_SEARCH | \
+                                     wxHF_BOOKMARKS | wxHF_PRINT)
+
+
 /**
     @class wxHtmlHelpFrame
 
-    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}
-    @category{FIXME}
+    @category{help,html}
 */
 class wxHtmlHelpFrame : public wxFrame
 {
 public:
-    //@{
+    wxHtmlHelpFrame(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.
     */
-    wxHtmlHelpFrame(wxHtmlHelpData* data = NULL);
-    wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
+    wxHtmlHelpFrame(wxWindow* parent, wxWindowID id,
                     const wxString& title = wxEmptyString,
                     int style = wxHF_DEFAULT_STYLE,
-                    wxHtmlHelpData* data = NULL);
-    //@}
+                    wxHtmlHelpData* data = NULL,
+                    wxConfigBase* config = NULL,
+                    const wxString& rootpath = wxEmptyString);
 
     /**
         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);
 
     /**
-        Creates the frame. See @ref wxhtmlhelpframe() "the constructor"
+        Creates the frame. See @ref wxHtmlHelpFrame() "the constructor"
         for a description of the parameters.
     */
     bool Create(wxWindow* parent, wxWindowID id,
-                const wxString& title = wxEmptyString,
-                int style = wxHF_DEFAULT_STYLE);
+                const wxString& title = wxEmptyString, int style = wxHF_DEFAULT_STYLE,
+                wxConfigBase* config = NULL,
+                const wxString& rootpath = wxEmptyString);
 
     /**
         Returns the help controller associated with the frame.
     */
     wxHtmlHelpController* GetController() const;
 
-    /**
-        Reads the user's settings for this frame see
-        wxHtmlHelpController::ReadCustomization)
-    */
-    void ReadCustomization(wxConfigBase* cfg,
-                           const wxString& path = wxEmptyString);
-
     /**
         Sets the help controller associated with the frame.
     */
-    void SetController(wxHtmlHelpController* contoller);
+    void SetController(wxHtmlHelpController* controller);
 
     /**
-        Sets the frame'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 frame's title format.
 
-    /**
-        Saves the user's settings for this frame (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);
 };