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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
.. 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
.. _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
<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>HtmlHelpDialog</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.html.HtmlHelpDialog_inheritance.png" alt="Inheritance diagram of HtmlHelpDialog" 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="5,5,107,35"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> <area shape="rect" id="node3" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="34,237,192,267"/> <area shape="rect" id="node5" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="42,315,184,344"/> <area shape="rect" id="node4" href="wx.Window.html" title="wx.Window" alt="" coords="69,160,157,189"/> <area shape="rect" id="node7" href="wx.Dialog.html" title="wx.Dialog" alt="" coords="72,392,153,421"/> <area shape="rect" id="node8" href="wx.html.HtmlHelpDialog.html" title="wx.html.HtmlHelpDialog" alt="" coords="26,469,200,499"/> </map>
</p>
|
|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.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=None)
HtmlHelpDialog(parent, id=ID_ANY, title="", style=HF_DEFAULT_STYLE,
data=None)
This class is used by HtmlHelpController to display help.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, data=None)`
:param `data`:
:type `data`: wx.html.HtmlHelpData
**~~~**
**__init__** `(self, parent, id=ID_ANY, title=EmptyString, style=HF_DEFAULT_STYLE, data=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
**~~~**
.. method:: AddToolbarButtons(self, toolBar, style)
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
.. method:: Create(self, parent, id=ID_ANY, title=EmptyString, style=HF_DEFAULT_STYLE)
Creates the dialog.
See :ref:`the constructor <wx.html.HtmlHelpDialog>` 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`
.. method:: GetController(self)
Returns the help controller associated with the dialog.
:rtype: :ref:`wx.html.HtmlHelpController`
.. method:: SetController(self, controller)
Sets the help controller associated with the dialog.
:param `controller`:
:type `controller`: wx.html.HtmlHelpController
.. method:: SetTitleFormat(self, format)
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
.. attribute:: Controller
See :meth:`~wx.html.HtmlHelpDialog.GetController` and :meth:`~wx.html.HtmlHelpDialog.SetController`
|
