1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 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
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>HTMLHelpWindow</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.agw.shortcuteditor.HTMLHelpWindow_inheritance.png" alt="Inheritance diagram of HTMLHelpWindow" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="43,5,144,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="95,83,205,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="90,160,211,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="168,5,249,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="106,237,195,267"/> <area shape="rect" id="node7" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="71,315,229,344"/> <area shape="rect" id="node6" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="79,392,221,421"/> <area shape="rect" id="node9" href="wx.Frame.html" title="wx.Frame" alt="" coords="109,469,191,499"/> <area shape="rect" id="node8" href="wx.lib.agw.shortcuteditor.HTMLHelpWindow.html" title="wx.lib.agw.shortcuteditor.HTMLHelpWindow" alt="" coords="5,547,296,576"/> </map>
</p>
|
|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`.
|
