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
|
.. 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.HtmlHelpData:
==========================================================================================================================================
|phoenix_title| **wx.html.HtmlHelpData**
==========================================================================================================================================
This class is used by :ref:`wx.html.HtmlHelpController` and :ref:`wx.html.HtmlHelpFrame` to access HTML help items.
It is internal class and should not be used directly - except for the case 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>HtmlHelpData</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.HtmlHelpData_inheritance.png" alt="Inheritance diagram of HtmlHelpData" 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.html.HtmlHelpData.html" title="wx.html.HtmlHelpData" alt="" coords="5,83,171,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="47,5,128,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.html.HtmlHelpData.__init__` Constructor.
:meth:`~wx.html.HtmlHelpData.AddBook` Adds new book.
:meth:`~wx.html.HtmlHelpData.FindPageById` Returns page's URL based on integer ``ID`` stored in project.
:meth:`~wx.html.HtmlHelpData.FindPageByName` Returns page's URL based on its (file)name.
:meth:`~wx.html.HtmlHelpData.GetBookRecArray` Returns array with help books info.
:meth:`~wx.html.HtmlHelpData.GetContentsArray` Returns reference to array with contents entries.
:meth:`~wx.html.HtmlHelpData.GetIndexArray` Returns reference to array with index entries.
:meth:`~wx.html.HtmlHelpData.SetTempDir` Sets the temporary directory where binary cached versions of MS HTML Workshop files will be stored.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.html.HtmlHelpData.BookRecArray` See :meth:`~wx.html.HtmlHelpData.GetBookRecArray`
:attr:`~wx.html.HtmlHelpData.ContentsArray` See :meth:`~wx.html.HtmlHelpData.GetContentsArray`
:attr:`~wx.html.HtmlHelpData.IndexArray` See :meth:`~wx.html.HtmlHelpData.GetIndexArray`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.html.HtmlHelpData(Object)
**Possible constructors**::
HtmlHelpData()
This class is used by HtmlHelpController and HtmlHelpFrame to
access HTML help items.
.. method:: __init__(self)
Constructor.
.. method:: AddBook(self, book_url)
Adds new book.
`book_url` is URL (not filename!) of HTML help project (hhp) or ``ZIP`` file that contains arbitrary number of .hhp projects (this zip file can have either .zip or .htb extension, htb stands for "html book").
Returns success.
:param `book_url`:
:type `book_url`: string
:rtype: `bool`
.. method:: FindPageById(self, id)
Returns page's URL based on integer ``ID`` stored in project.
:param `id`:
:type `id`: int
:rtype: `string`
.. method:: FindPageByName(self, page)
Returns page's URL based on its (file)name.
:param `page`:
:type `page`: string
:rtype: `string`
.. method:: GetBookRecArray(self)
Returns array with help books info.
:rtype: :ref:`HtmlBookRecArray`
.. method:: GetContentsArray(self)
Returns reference to array with contents entries.
:rtype: :ref:`HtmlHelpDataItems`
.. method:: GetIndexArray(self)
Returns reference to array with index entries.
:rtype: :ref:`HtmlHelpDataItems`
.. method:: SetTempDir(self, path)
Sets the temporary directory where binary cached versions of MS HTML Workshop files will be stored.
(This is turned off by default and you can enable this feature by setting non-empty temp dir.)
:param `path`:
:type `path`: string
.. attribute:: BookRecArray
See :meth:`~wx.html.HtmlHelpData.GetBookRecArray`
.. attribute:: ContentsArray
See :meth:`~wx.html.HtmlHelpData.GetContentsArray`
.. attribute:: IndexArray
See :meth:`~wx.html.HtmlHelpData.GetIndexArray`
|
