X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..0eb1fbf01b2444e54cf8a25a5dff5f97f0b3442a:/interface/wx/html/helpfrm.h diff --git a/interface/wx/html/helpfrm.h b/interface/wx/html/helpfrm.h index 4bb71f9cd2..73f735380c 100644 --- a/interface/wx/html/helpfrm.h +++ b/interface/wx/html/helpfrm.h @@ -3,79 +3,69 @@ // Purpose: interface of wxHtmlHelpFrame // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @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, 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); };