phoenix_title wx.lib.agw.shortcuteditor.HTMLHelpWindow

A simple wx.Frame container for the basic help provided to ShortcutEditor. The help page is actually straightly derived from:

http://graphicssoft.about.com/od/gimptutorials/tp/keyboard-shortcut-editor.htm


class_hierarchy Class Hierarchy

Inheritance diagram for class HTMLHelpWindow:

super_classes Known Superclasses

wx.Frame


method_summary Methods Summary

__init__

Default class constructor.

BuildToolBar

Creates a toolbar for HTMLHelpWindow containing the standard browsing

OnClose

Handles the wx.EVT_CLOSE event for HTMLHelpWindow.

OnHTMLToolbar

Handles all the wx.EVT_TOOL events for HTMLHelpWindow.

OnUpdateUI

Handles all the wx.EVT_UPDATE_UI events for HTMLHelpWindow.


api Class API

class HTMLHelpWindow(wx.Frame)

A simple wx.Frame container for the basic help provided to ShortcutEditor. The help page is actually straightly derived from:

http://graphicssoft.about.com/od/gimptutorials/tp/keyboard-shortcut-editor.htm


Methods

__init__(self, parent, htmlFile)

Default class constructor.

Parameters:
  • parent – an instance of ShortcutEditor;

  • htmlFile (string) – a valid HTML file containing either the default help or your particular definition of help.



BuildToolBar(self, toolbar)

Creates a toolbar for HTMLHelpWindow containing the standard browsing buttons like Back, Forward, Home, Refresh and Print.

Parameters:

toolbar – an instance of ToolBar.



OnClose(self, event)

Handles the wx.EVT_CLOSE event for HTMLHelpWindow.

Parameters:

event – an instance of CloseEvent.



OnHTMLToolbar(self, event)

Handles all the wx.EVT_TOOL events for HTMLHelpWindow.

Parameters:

event – an instance of CommandEvent.



OnUpdateUI(self, event)

Handles all the wx.EVT_UPDATE_UI events for HTMLHelpWindow.

Parameters:

event – an instance of UpdateUIEvent.