wx.html.HtmlHelpFrame¶This class is used by wx.html.HtmlHelpController 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.
Class Hierarchy¶
Inheritance diagram for class HtmlHelpFrame:

Methods Summary¶You may override this virtual method to add more buttons to the help window’s toolbar. |
|
Creates the frame. |
|
Returns the help controller associated with the frame. |
|
Sets the help controller associated with the frame. |
|
Sets the frame’s title format. |
Properties Summary¶See |
Class API¶wx.html.HtmlHelpFrame(Frame)¶Possible constructors:
HtmlHelpFrame(data=None)
HtmlHelpFrame(parent, id=ID_ANY, title="", style=HF_DEFAULT_STYLE,
data=None, config=None, rootpath="")
This class is used by HtmlHelpController to display help.
__init__(self, *args, **kw)¶__init__ (self, data=None)
data (wx.html.HtmlHelpData) –
__init__ (self, parent, id=ID_ANY, title=””, style=HF_DEFAULT_STYLE, data=None, config=None, rootpath=””)
Constructor.
For the possible values of style, please see wx.html.HtmlHelpController.
parent (wx.Window) –
id (wx.WindowID) –
title (string) –
style (int) –
data (wx.html.HtmlHelpData) –
config (wx.ConfigBase) –
rootpath (string) –
AddToolbarButtons(self, toolBar, style)¶You may override this virtual method to add more buttons to the help window’s toolbar.
toolBar is a pointer to the toolbar and style is the style flag as passed to the Create method.
wx.ToolBar.Realize is called immediately after returning from this function.
toolBar (wx.ToolBar) –
style (int) –
Create(self, parent, id=ID_ANY, title="", style=HF_DEFAULT_STYLE, config=None, rootpath="")¶Creates the frame.
See the constructor for a description of the parameters.
parent (wx.Window) –
id (wx.WindowID) –
title (string) –
style (int) –
config (wx.ConfigBase) –
rootpath (string) –
bool
GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶variant (WindowVariant) –
VisualAttributes
GetController(self)¶Returns the help controller associated with the frame.
SetController(self, controller)¶Sets the help controller associated with the frame.
controller (wx.html.HtmlHelpController) –
SetTitleFormat(self, format)¶Sets the frame’s title format.
format must contain exactly one “%s” (it will be replaced by the page title).
format (string) –
Controller¶See GetController and SetController