*********************
wx.html.HtmlHelpFrame
*********************
Inheritance diagram for `wx.html.HtmlHelpFrame`:
|
.. inheritance-diagram:: wx.html.HtmlHelpFrame
|
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.Frame <../Widgets/wx.Frame.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__>`_
* `AddGrabIfNeeded <#AddGrabIfNeeded>`_
* `Create <#Create>`_
* `Display <#Display>`_
* `DisplayContents <#DisplayContents>`_
* `DisplayID <#DisplayID>`_
* `DisplayIndex <#DisplayIndex>`_
* `GetController <#GetController>`_
* `GetData <#GetData>`_
* `GetHelpWindow <#GetHelpWindow>`_
* `KeywordSearch <#KeywordSearch>`_
* `ReadCustomization <#ReadCustomization>`_
* `SetController <#SetController>`_
* `SetTitleFormat <#SetTitleFormat>`_
* `UseConfig <#UseConfig>`_
* `WriteCustomization <#WriteCustomization>`_
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.HtmlHelpFrame `_
--------
.. method:: AddGrabIfNeeded()
`No docstrings available for this method.`
--------
.. 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:: Display(x)
See `wx.html.HtmlHelpController.Display `_
**Parameters:**
* `x` (string)
--------
.. method:: DisplayContents()
See `wx.html.HtmlHelpController.DisplayContents `_
--------
.. method:: DisplayID(x)
See `wx.html.HtmlHelpController.DisplayId `_
**Parameters:**
* `x` (int)
--------
.. method:: DisplayIndex()
See `wx.html.HtmlHelpController.DisplayIndex `_
--------
.. method:: GetController()
Returns the help controller associated with the frame.
|
**Returns:**
`wx.html.HtmlHelpController `_
--------
.. method:: GetData()
`No docstrings available for this method.`
--------
.. method:: GetHelpWindow()
`No docstrings available for this method.`
--------
.. method:: KeywordSearch(keyword, mode=wx.html.HELP_SEARCH_ALL)
See `wx.html.HtmlHelpController.KeywordSearch `_
**Parameters:**
* `keyword` (string)
* `mode` (int)
--------
.. method:: ReadCustomization(cfg, path="")
Reads the user's settings for this frame, see `wx.html.HtmlHelpController.ReadCustomization `_
**Parameters:**
* `cfg` (`wx.ConfigBase <../Widgets/wx.ConfigBase.html>`_)
* `path` (string)
--------
.. method:: SetController(contoller)
Sets the help controller associated with the frame.
**Parameters:**
* `controller` (`wx.html.HtmlHelpController `_)
--------
.. method:: SetTitleFormat(format)
Sets the frame's title format.
`format` must contain exactly one "%s" (it will be replaced by the page title).
**Parameters:**
* `format` (string)
--------
.. method:: UseConfig(config, rootpath='')
See `wx.html.HtmlHelpController.UseConfig `_
**Parameters:**
* `config` (`wx.ConfigBase <../Widgets/wx.ConfigBase.html>`_)
* `rootpath` (string)
--------
.. method:: WriteCustomization(cfg, path="")
Saves the user's settings for this frame (see `wx.html.HtmlHelpController.WriteCustomization `_).
**Parameters:**
* `cfg` (`wx.ConfigBase <../Widgets/wx.ConfigBase.html>`_)
* `path` (string)
--------
Properties
^^^^^^^^^^
.. attribute:: Controller
See `GetController <#GetController>`_ and `SetController <#SetController>`_
.. attribute:: Data
See `GetData <#GetData>`_
.. attribute:: HelpWindow
See `GetHelpWindow <#GetHelpWindow>`_