.. 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
.. currentmodule:: wx.lib.agw.shortcuteditor
.. highlight:: python
.. _wx.lib.agw.shortcuteditor.HTMLHelpWindow:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.shortcuteditor.HTMLHelpWindow**
==========================================================================================================================================
A simple :class:`wx.Frame` container for the basic help provided to :class:`ShortcutEditor`.
The help page is actually straightly derived from:
http://graphicssoft.about.com/od/gimptutorials/tp/keyboard-shortcut-editor.htm
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
HTMLHelpWindow:
|
|super_classes| Known Superclasses
==================================
:class:`wx.Frame`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.shortcuteditor.HTMLHelpWindow.__init__` Default class constructor.
:meth:`~wx.lib.agw.shortcuteditor.HTMLHelpWindow.BuildToolBar` Creates a toolbar for :class:`HTMLHelpWindow` containing the standard browsing
:meth:`~wx.lib.agw.shortcuteditor.HTMLHelpWindow.OnClose` Handles the ``wx.EVT_CLOSE`` event for :class:`HTMLHelpWindow`.
:meth:`~wx.lib.agw.shortcuteditor.HTMLHelpWindow.OnHTMLToolbar` Handles all the ``wx.EVT_TOOL`` events for :class:`HTMLHelpWindow`.
:meth:`~wx.lib.agw.shortcuteditor.HTMLHelpWindow.OnUpdateUI` Handles all the ``wx.EVT_UPDATE_UI`` events for :class:`HTMLHelpWindow`.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: HTMLHelpWindow(wx.Frame)
A simple :class:`wx.Frame` container for the basic help provided to :class:`ShortcutEditor`.
The help page is actually straightly derived from:
http://graphicssoft.about.com/od/gimptutorials/tp/keyboard-shortcut-editor.htm
.. method:: __init__(self, parent, htmlFile)
Default class constructor.
:param `parent`: an instance of :class:`ShortcutEditor`;
:param string `htmlFile`: a valid HTML file containing either the default help
or your particular definition of help.
.. method:: BuildToolBar(self, toolbar)
Creates a toolbar for :class:`HTMLHelpWindow` containing the standard browsing
buttons like `Back`, `Forward`, `Home`, `Refresh` and `Print`.
:param `toolbar`: an instance of :class:`ToolBar`.
.. method:: OnClose(self, event)
Handles the ``wx.EVT_CLOSE`` event for :class:`HTMLHelpWindow`.
:param `event`: an instance of :class:`CloseEvent`.
.. method:: OnHTMLToolbar(self, event)
Handles all the ``wx.EVT_TOOL`` events for :class:`HTMLHelpWindow`.
:param `event`: an instance of :class:`CommandEvent`.
.. method:: OnUpdateUI(self, event)
Handles all the ``wx.EVT_UPDATE_UI`` events for :class:`HTMLHelpWindow`.
:param `event`: an instance of :class:`UpdateUIEvent`.