X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5267aefd85739afd26bd19bfba998005119db446..36a0190ebd5bd9a7302f60f6dcd608b80574e21c:/interface/wx/html/helpwnd.h diff --git a/interface/wx/html/helpwnd.h b/interface/wx/html/helpwnd.h index e175f4d14c..870f8ad313 100644 --- 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,21 +79,11 @@ 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. @@ -70,11 +93,6 @@ public: const wxSize& size = wxDefaultSize, int style = wxTAB_TRAVERSAL|wxBORDER_NONE, int helpStyle = wxHF_DEFAULT_STYLE); - /** - Creates search panel. - */ - void CreateSearch(); - /** Displays page x. If not found it will give the user the choice of searching books. @@ -125,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. @@ -147,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.) */ @@ -158,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(); };