wx.html.HtmlHelpDialog

Inheritance diagram for wx.html.HtmlHelpDialog:

Description

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.

Derived From

• wx.Dialog
• wx.TopLevelWindow
• wx.Window
• wx.EvtHandler
• wx.Object

Methods Summary

• __init__
• Create
• GetController
• GetData
• GetHelpWindow
• SetController
• SetTitleFormat

Properties Summary

• Controller
• Data
• HelpWindow

Class API

Methods

__init__(parent, id, title="", style=wx.html.HF_DEFAULT_STYLE, data=None)

Constructor.

Parameters:

• parent (wx.Window): Parent window.
• id (int): Window Id.
• title (string): Window title
• style (long): For the possible values of style, see wx.html.HtmlHelpController.__init__
• data (wx.html.HtmlHelpData):

Returns:

wx.html.HtmlHelpDialog

---

Create(parent, id, title="", style=wx.html.HF_DEFAULT_STYLE)

Creates the dialog.

Parameters:

• parent (wx.Window): Parent window.
• id (int): Window Id.
• title (string): Window title
• style (long): For the possible values of style, see wx.html.HtmlHelpController.__init__

Returns:

bool

---

GetController()

Returns the help controller associated with the dialog.

Returns:

wx.html.HtmlHelpController

---

GetData()

No docstrings available for this method.

---

GetHelpWindow()

No docstrings available for this method.

---

SetController(controller)

Sets the help controller associated with the dialog.

Parameters:

• controller (wx.html.HtmlHelpController)

---

SetTitleFormat(format)

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

Data

See GetData

HelpWindow

See GetHelpWindow