.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.html.HtmlHelpDialog:
==========================================================================================================================================
|phoenix_title| **wx.html.HtmlHelpDialog**
==========================================================================================================================================
This class is used by :ref:`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.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
HtmlHelpDialog:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.html.HtmlHelpDialog.__init__`
:meth:`~wx.html.HtmlHelpDialog.AddToolbarButtons` You may override this virtual method to add more buttons to the help window's toolbar.
:meth:`~wx.html.HtmlHelpDialog.Create` Creates the dialog.
:meth:`~wx.html.HtmlHelpDialog.GetClassDefaultAttributes`
:meth:`~wx.html.HtmlHelpDialog.GetController` Returns the help controller associated with the dialog.
:meth:`~wx.html.HtmlHelpDialog.SetController` Sets the help controller associated with the dialog.
:meth:`~wx.html.HtmlHelpDialog.SetTitleFormat` Sets the dialog's title format.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.html.HtmlHelpDialog.Controller` See :meth:`~wx.html.HtmlHelpDialog.GetController` and :meth:`~wx.html.HtmlHelpDialog.SetController`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.html.HtmlHelpDialog(Dialog)
**Possible constructors**::
HtmlHelpDialog(data: Optional[HtmlHelpData]=None) -> None
HtmlHelpDialog(parent : Window, id: int=ID_ANY, title: str='', style:
int=HF_DEFAULT_STYLE, data: Optional[HtmlHelpData]=None) -> None
This class is used by HtmlHelpController to display help.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self, data: Optional[HtmlHelpData]=None)`
:param `data`:
:type `data`: wx.html.HtmlHelpData
:rtype: `None`
:html:`
`
**__init__** `(self, parent : Window, id: int=ID_ANY, title: str='', style: int=HF_DEFAULT_STYLE, data: Optional[HtmlHelpData]=None)`
Constructor.
For the possible values of `style`, please see :ref:`wx.html.HtmlHelpController`.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `title`:
:type `title`: string
:param `style`:
:type `style`: int
:param `data`:
:type `data`: wx.html.HtmlHelpData
:rtype: `None`
:html:`
`
.. method:: AddToolbarButtons(self, toolBar : ToolBar, style : int)
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 :meth:`Create` method.
:meth:`wx.ToolBar.Realize` is called immediately after returning from this function.
:param `toolBar`:
:type `toolBar`: wx.ToolBar
:param `style`:
:type `style`: int
:rtype: `None`
.. method:: Create(self, parent : Window, id: int=ID_ANY, title: str='', style: int=HF_DEFAULT_STYLE)
Creates the dialog.
See :ref:`the constructor ` for a description of the parameters.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `title`:
:type `title`: string
:param `style`:
:type `style`: int
:rtype: `bool`
.. staticmethod:: GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: `VisualAttributes`
.. method:: GetController(self)
Returns the help controller associated with the dialog.
:rtype: :ref:`wx.html.HtmlHelpController`
.. method:: SetController(self, controller : HtmlHelpController)
Sets the help controller associated with the dialog.
:param `controller`:
:type `controller`: wx.html.HtmlHelpController
:rtype: `None`
.. method:: SetTitleFormat(self, format : str)
Sets the dialog's title format.
`format` must contain exactly one "%s" (it will be replaced by the page title).
:param `format`:
:type `format`: string
:rtype: `None`
.. attribute:: Controller
See :meth:`~wx.html.HtmlHelpDialog.GetController` and :meth:`~wx.html.HtmlHelpDialog.SetController`