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¶
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¶
- class wx.html.HtmlHelpFrame(Frame)¶
Possible constructors:
HtmlHelpFrame(data=None) -> None HtmlHelpFrame(parent, id=ID_ANY, title='', style=HF_DEFAULT_STYLE, data=None, config=None, rootpath='') -> None
This class is used by HtmlHelpController to display help.
Methods¶
- __init__(self, *args, **kw)¶
-
__init__ (self, data=None)
- Parameters:
data (wx.html.HtmlHelpData)
- Return type:
None
__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)
- Return type:
None
- 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)
- Return type:
None
- 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
- static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶
- Parameters:
variant (WindowVariant)
- Return type:
VisualAttributes
- GetController(self)¶
Returns the help controller associated with the frame.
- Return type:
- SetController(self, controller)¶
Sets the help controller associated with the frame.
- Parameters:
controller (wx.html.HtmlHelpController)
- Return type:
None
- 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)
- Return type:
None
Properties¶
- Controller¶
See
GetController
andSetController