**********************
wx.html.HtmlHelpDialog
**********************
Inheritance diagram for `wx.html.HtmlHelpDialog`:
|
.. inheritance-diagram:: 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 <../Widgets/wx.Dialog.html>`_
* `wx.TopLevelWindow <../Widgets/wx.TopLevelWindow.html>`_
* `wx.Window <../Widgets/wx.Window.html>`_
* `wx.EvtHandler <../Widgets/wx.EvtHandler.html>`_
* `wx.Object <../Widgets/wx.Object.html>`_
Methods Summary
^^^^^^^^^^^^^^^
* `__init__ <#__init__>`_
* `Create <#Create>`_
* `GetController <#GetController>`_
* `GetData <#GetData>`_
* `GetHelpWindow <#GetHelpWindow>`_
* `SetController <#SetController>`_
* `SetTitleFormat <#SetTitleFormat>`_
Properties Summary
^^^^^^^^^^^^^^^^^^
* `Controller <#Controller>`_
* `Data <#Data>`_
* `HelpWindow <#HelpWindow>`_
Class API
=========
Methods
^^^^^^^
.. method:: __init__(parent, id, title="", style=wx.html.HF_DEFAULT_STYLE, data=None)
Constructor.
**Parameters:**
* `parent` (`wx.Window <../Widgets/wx.Window.html>`_): 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 `_
--------
.. method:: Create(parent, id, title="", style=wx.html.HF_DEFAULT_STYLE)
Creates the dialog.
**Parameters:**
* `parent` (`wx.Window <../Widgets/wx.Window.html>`_): 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`
--------
.. method:: GetController()
Returns the help controller associated with the dialog.
|
**Returns:**
`wx.html.HtmlHelpController `_
--------
.. method:: GetData()
`No docstrings available for this method.`
--------
.. method:: GetHelpWindow()
`No docstrings available for this method.`
--------
.. method:: SetController(controller)
Sets the help controller associated with the dialog.
**Parameters:**
* `controller` (`wx.html.HtmlHelpController `_)
--------
.. method:: 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
^^^^^^^^^^
.. attribute:: Controller
See `GetController <#GetController>`_ and `SetController <#SetController>`_
.. attribute:: Data
See `GetData <#GetData>`_
.. attribute:: HelpWindow
See `GetHelpWindow <#GetHelpWindow>`_