1 /////////////////////////////////////////////////////////////////////////////
2 // Name: html/helpdlg.h
3 // Purpose: interface of wxHtmlHelpDialog
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
10 @class wxHtmlHelpDialog
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 wxHtmlHelpDialog
: public wxFrame
22 wxHtmlHelpDialog(wxHtmlHelpData
* data
= NULL
);
27 For the possible values of @a style, please see wxHtmlHelpController.
29 wxHtmlHelpDialog(wxWindow
* parent
, int wxWindowID
,
30 const wxString
& title
= wxEmptyString
,
31 int style
= wxHF_DEFAULT_STYLE
,
32 wxHtmlHelpData
* data
= NULL
);
35 You may override this virtual method to add more buttons to the help window's
36 toolbar. @a toolBar is a pointer to the toolbar and @a style is the style
37 flag as passed to the Create() method.
39 wxToolBar::Realize is called immediately after returning from this function.
41 virtual void AddToolbarButtons(wxToolBar
* toolBar
, int style
);
44 Creates the dialog. See @ref wxHtmlHelpDialog() "the constructor"
45 for a description of the parameters.
47 bool Create(wxWindow
* parent
, wxWindowID id
,
48 const wxString
& title
= wxEmptyString
,
49 int style
= wxHF_DEFAULT_STYLE
);
52 Returns the help controller associated with the dialog.
54 wxHtmlHelpController
* GetController() const;
57 Sets the help controller associated with the dialog.
59 void SetController(wxHtmlHelpController
* controller
);
62 Sets the dialog's title format.
64 @a format must contain exactly one "%s" (it will be replaced by the page title).
66 void SetTitleFormat(const wxString
& format
);