1 /////////////////////////////////////////////////////////////////////////////
2 // Name: html/helpfrm.h
3 // Purpose: interface of wxHtmlHelpFrame
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
10 @class wxHtmlHelpFrame
12 This class is used by wxHtmlHelpController to display help.
13 It is an internal class and should not be used directly - except for the case
14 when you're writing your own HTML help controller.
19 class wxHtmlHelpFrame
: public wxFrame
22 wxHtmlHelpFrame(wxHtmlHelpData
* data
= NULL
);
27 For the possible values of @a style, please see wxHtmlHelpController.
29 wxHtmlHelpFrame(wxWindow
* parent
, int wxWindowID
,
30 const wxString
& title
= wxEmptyString
,
31 int style
= wxHF_DEFAULT_STYLE
,
32 wxHtmlHelpData
* data
= NULL
,
33 wxConfigBase
* config
= NULL
,
34 const wxString
& rootpath
= wxEmptyString
);
37 You may override this virtual method to add more buttons to the help window's
38 toolbar. @a toolBar is a pointer to the toolbar and @a style is the style
39 flag as passed to the Create() method.
41 wxToolBar::Realize is called immediately after returning from this function.
43 virtual void AddToolbarButtons(wxToolBar
* toolBar
, int style
);
46 Creates the frame. See @ref wxHtmlHelpFrame() "the constructor"
47 for a description of the parameters.
49 bool Create(wxWindow
* parent
, wxWindowID id
,
50 const wxString
& title
= wxEmptyString
, int style
= wxHF_DEFAULT_STYLE
,
51 wxConfigBase
* config
= NULL
,
52 const wxString
& rootpath
= wxEmptyString
);
55 Returns the help controller associated with the frame.
57 wxHtmlHelpController
* GetController() const;
60 Sets the help controller associated with the frame.
62 void SetController(wxHtmlHelpController
* controller
);
65 Sets the frame's title format.
67 @a format must contain exactly one "%s" (it will be replaced by the page title).
69 void SetTitleFormat(const wxString
& format
);