wx.html.HtmlHelpDialog¶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 HtmlHelpDialog:
Methods Summary¶You may override this virtual method to add more buttons to the help window’s toolbar. |
|
Creates the dialog. |
|
Returns the help controller associated with the dialog. |
|
Sets the help controller associated with the dialog. |
|
Sets the dialog’s title format. |
Properties Summary¶See |
Class API¶wx.html.HtmlHelpDialog(Dialog)¶Possible constructors:
HtmlHelpDialog(data: Optional[HtmlHelpData]=None) -> None
HtmlHelpDialog(parent : Window, id: int=ID_ANY, title: str='', style:
int=HF_DEFAULT_STYLE, data: Optional[HtmlHelpData]=None) -> None
This class is used by HtmlHelpController to display help.
__init__(self, *args, **kw)¶__init__ (self, data: Optional[HtmlHelpData]=None)
data (wx.html.HtmlHelpData) –
None
__init__ (self, parent : Window, id: int=ID_ANY, title: str=’’, style: int=HF_DEFAULT_STYLE, data: Optional[HtmlHelpData]=None)
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) –
None
AddToolbarButtons(self, toolBar : ToolBar, style : int)¶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) –
None
Create(self, parent : Window, id: int=ID_ANY, title: str='', style: int=HF_DEFAULT_STYLE)¶Creates the dialog.
See the constructor for a description of the parameters.
parent (wx.Window) –
id (wx.WindowID) –
title (string) –
style (int) –
bool
GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL)¶variant (WindowVariant) –
VisualAttributes
GetController(self)¶Returns the help controller associated with the dialog.
SetController(self, controller : HtmlHelpController)¶Sets the help controller associated with the dialog.
controller (wx.html.HtmlHelpController) –
None
SetTitleFormat(self, format : str)¶Sets the dialog’s title format.
format must contain exactly one “%s” (it will be replaced by the page title).
format (string) –
None
Controller¶See GetController and SetController