]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/html/helpwnd.h
Make the CreateTool factories be public so they can be used from application code
[wxWidgets.git] / interface / wx / html / helpwnd.h
index 5b8d287d6dc81d69edf5f8eb63f6b85b269a250f..b58b21d084727f508c84e81be40e420a5001ff88 100644 (file)
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxHtmlHelpWindow
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -23,7 +23,7 @@
         m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);
         m_embeddedHelpWindow->Create(this, wxID_ANY, wxDefaultPosition, GetClientSize(),
                                      wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);
-        m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip")));
+        m_embeddedHtmlHelp.AddBook(wxFileName(wxT("doc.zip")));
     @endcode
 
     You should pass the style wxHF_EMBEDDED to the style parameter of
@@ -51,31 +51,14 @@ public:
                      int helpStyle = 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
-        flag as passed to the Create() method.
-
-        wxToolBar::Realize is called immediately after returning from this function.
-        See @c samples/html/helpview for an example.
-    */
-    virtual void AddToolbarButtons(wxToolBar* toolBar, int style);
-
     /**
         Creates the help window. See @ref wxHtmlHelpWindow() "the constructor"
         for a description of the parameters.
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
-                const wxSize& pos = wxDefaultSize,
-                int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
-                int helpStyle = wxHF_DEFAULT_STYLE,
-                wxHtmlHelpData* data = NULL);
-
-    /**
-        Creates search panel.
-    */
-    void CreateSearch();
+                const wxSize& size = wxDefaultSize, int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
+                int helpStyle = wxHF_DEFAULT_STYLE);
 
     /**
         Displays page x.
@@ -127,13 +110,6 @@ public:
     void ReadCustomization(wxConfigBase* cfg,
                            const wxString& path = wxEmptyString);
 
-    /**
-        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);
-
     /**
         Associates a wxConfig object with the help window. It is recommended that you
         use wxHtmlHelpController::UseConfig instead.
@@ -149,8 +125,28 @@ public:
     void WriteCustomization(wxConfigBase* cfg,
                             const wxString& path = wxEmptyString);
 
+    /**
+        Refresh all panels. This is necessary if a new book was added.
+    */
+    void RefreshLists();
+
 protected:
 
+    /**
+        Creates search panel.
+    */
+    void CreateSearch();
+
+    /**
+        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.
+
+        wxToolBar::Realize is called immediately after returning from this function.
+        See @c samples/html/helpview for an example.
+    */
+    virtual void AddToolbarButtons(wxToolBar* toolBar, int style);
+
     /**
         Creates contents panel. (May take some time.)
     */
@@ -160,10 +156,5 @@ protected:
         Creates index panel. (May take some time.)
     */
     void CreateIndex();
-
-    /**
-        Refresh all panels. This is necessary if a new book was added.
-    */
-    void RefreshLists();
 };