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¶

`__init__`
`AddToolbarButtons`	You may override this virtual method to add more buttons to the help window’s toolbar.
`Create`	Creates the frame.
`GetController`	Returns the help controller associated with the frame.
`SetController`	Sets the help controller associated with the frame.
`SetTitleFormat`	Sets the frame’s title format.

Properties Summary¶

Controller See GetController and SetController

Class API¶

class 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.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self, data=None)

Parameters:	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.

Parameters:	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.

Parameters:	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.

Parameters:	parent (wx.Window) – id (wx.WindowID) – title (string) – style (int) – config (wx.ConfigBase) – rootpath (string) –
Return type:	bool

GetController(self)¶

Returns the help controller associated with the frame.

Return type:	wx.html.HtmlHelpController

SetController(self, controller)¶

Sets the help controller associated with the frame.

Parameters:	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).

Parameters:	format (string) –

Properties¶

Controller¶: See GetController and SetController

Navigation