Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/html/helpwnd.h b/interface/wx/html/helpwnd.h
index 5b8d287d6dc81d69edf5f8eb63f6b85b269a250f..870f8ad313a2435ab89efba9a9a333b1780487ae 100644 (file)
--- a/interface/wx/html/helpwnd.h
+++ b/interface/wx/html/helpwnd.h
@@ -2,10 +2,43 @@
 // Name:        html/helpwnd.h
 // Purpose:     interface of wxHtmlHelpWindow
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+/*!
+ * Command IDs
+ */
+enum
+{
+    //wxID_HTML_HELPFRAME = wxID_HIGHEST + 1,
+    wxID_HTML_PANEL = wxID_HIGHEST + 10,
+    wxID_HTML_BACK,
+    wxID_HTML_FORWARD,
+    wxID_HTML_UPNODE,
+    wxID_HTML_UP,
+    wxID_HTML_DOWN,
+    wxID_HTML_PRINT,
+    wxID_HTML_OPENFILE,
+    wxID_HTML_OPTIONS,
+    wxID_HTML_BOOKMARKSLIST,
+    wxID_HTML_BOOKMARKSADD,
+    wxID_HTML_BOOKMARKSREMOVE,
+    wxID_HTML_TREECTRL,
+    wxID_HTML_INDEXPAGE,
+    wxID_HTML_INDEXLIST,
+    wxID_HTML_INDEXTEXT,
+    wxID_HTML_INDEXBUTTON,
+    wxID_HTML_INDEXBUTTONALL,
+    wxID_HTML_NOTEBOOK,
+    wxID_HTML_SEARCHPAGE,
+    wxID_HTML_SEARCHTEXT,
+    wxID_HTML_SEARCHLIST,
+    wxID_HTML_SEARCHBUTTON,
+    wxID_HTML_SEARCHCHOICE,
+    wxID_HTML_COUNTINFO
+};
+
+
 /**
     @class wxHtmlHelpWindow
 
@@ -23,7 +56,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
@@ -46,36 +79,19 @@ public:
     */
     wxHtmlHelpWindow(wxWindow* parent, int wxWindowID,
                      const wxPoint& pos = wxDefaultPosition,
-                     const wxSize& pos = wxDefaultSize,
+                     const wxSize& size = wxDefaultSize,
                      int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
                      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 +143,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 +158,32 @@ public:
     void WriteCustomization(wxConfigBase* cfg,
                             const wxString& path = wxEmptyString);
 
+    /**
+        Refresh all panels. This is necessary if a new book was added.
+    */
+    void RefreshLists();
+
+
+    wxHtmlHelpController* GetController() const;
+    void SetController(wxHtmlHelpController* controller);
+
 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 +193,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();
 };