.. 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.HtmlModalHelp: ========================================================================================================================================== |phoenix_title| **wx.html.HtmlModalHelp** ========================================================================================================================================== This class uses :ref:`wx.html.HtmlHelpController` to display help in a modal dialog. This is useful on platforms such as Mac where if you display help from a modal dialog, the help window must itself be a modal dialog. Create objects of this class on the stack, for example: :: # The help can be browsed during the lifetime of self object when the # user quits the help, program execution will continue. help = wx.html.HtmlModalHelp(parent, "help", "My topic") | |class_hierarchy| Class Hierarchy ================================= .. raw:: html
Inheritance diagram for class HtmlModalHelp:
| |method_summary| Methods Summary ================================ ================================================================================ ================================================================================ :meth:`~wx.html.HtmlModalHelp.__init__` The constructor. ================================================================================ ================================================================================ | |api| Class API =============== .. class:: wx.html.HtmlModalHelp(object) **Possible constructors**:: HtmlModalHelp(parent, helpFile, topic="", style=HF_DEFAULT_STYLE|HF_DIALOG|HF_MODAL) This class uses HtmlHelpController to display help in a modal dialog. .. method:: __init__(self, parent, helpFile, topic="", style=HF_DEFAULT_STYLE|HF_DIALOG|HF_MODAL) The constructor. :param `parent`: is the parent of the dialog. :type `parent`: wx.Window :param `helpFile`: is the HTML help file to show. :type `helpFile`: string :param `topic`: is an optional topic. If this is empty, the help contents will be shown. :type `topic`: string :param `style`: is a combination of the flags described in the :ref:`wx.html.HtmlHelpController` documentation. :type `style`: int