Class Hierarchy¶

Inheritance diagram for class HtmlHelpDialog:

Methods Summary¶

Properties Summary¶

Class API¶

class wx.html.HtmlHelpDialog(Dialog)¶

Possible constructors:

HtmlHelpDialog(data=None) -> None

HtmlHelpDialog(parent, id=ID_ANY, title='', style=HF_DEFAULT_STYLE,
               data=None) -> None

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)

Return type:

None

---

__init__ (self, parent, id=ID_ANY, title=’’, style=HF_DEFAULT_STYLE, data=None)

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)

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)¶

Creates the dialog.

See the constructor for a description of the parameters.

Parameters:

• parent (wx.Window)

• id (wx.WindowID)

• title (string)

• style (int)

Return type:

bool

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters:

variant (WindowVariant)

Return type:

VisualAttributes

---

GetController(self)¶

Returns the help controller associated with the dialog.

Return type:

wx.html.HtmlHelpController

---

SetController(self, controller)¶

Sets the help controller associated with the dialog.

Parameters:

controller (wx.html.HtmlHelpController)

Return type:

None

---

SetTitleFormat(self, format)¶

Sets the dialog’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 and SetController