*********************
wx.html.HtmlModalHelp
*********************
Inheritance diagram for `wx.html.HtmlModalHelp`:
|
.. inheritance-diagram:: wx.html.HtmlModalHelp
|
Description
===========
This class uses `wx.html.HtmlHelpController `_ to display help in a modal dialog.
This is useful on platforms such as wxMac where if you display help from a modal dialog, the help window must itself be a modal dialog.
Methods Summary
^^^^^^^^^^^^^^^
* `__init__ <#__init__>`_
Class API
=========
Methods
^^^^^^^
.. method:: __init__(parent, helpFile, topic="", style=wx.html.HF_DEFAULT_STYLE|wx.html.HF_DIALOG|wx.html.HF_MODAL)
Constructor.
**Parameters:**
* `parent` (`wx.Window <../Widgets/wx.Window.html>`_): The parent of the dialog.
* `helpFile` (string): HTML file to show.
* `topic` (string): An optional topic. If empty, the help contents will be shown.
* `style` (int): A combination of style flags from `wx.html.HtmlHelpController.__init__ `_
|
**Returns:**
`wx.html.HtmlModalHelp `_