wx.html.HtmlHelpData¶

This class is used by wx.html.HtmlHelpController and 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¶

Inheritance diagram for class HtmlHelpData:

Methods Summary¶

`__init__`	Constructor.
`AddBook`	Adds new book.
`FindPageById`	Returns page’s URL based on integer `ID` stored in project.
`FindPageByName`	Returns page’s URL based on its (file)name.
`GetBookRecArray`	Returns array with help books info.
`GetContentsArray`	Returns reference to array with contents entries.
`GetIndexArray`	Returns reference to array with index entries.
`SetTempDir`	Sets the temporary directory where binary cached versions of MS HTML Workshop files will be stored.

Properties Summary¶

`BookRecArray`	See `GetBookRecArray`
`ContentsArray`	See `GetContentsArray`
`IndexArray`	See `GetIndexArray`

Class API¶

class wx.html.HtmlHelpData(Object)¶

Possible constructors:

HtmlHelpData() -> None

This class is used by HtmlHelpController and HtmlHelpFrame to access HTML help items.

Methods¶

__init__(self)¶

Constructor.

Return type:: None

AddBook(self, book_url: str)¶

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.

Parameters:: book_url (string)
Return type:: bool

FindPageById(self, id: int)¶

Returns page’s URL based on integer ID stored in project.

Parameters:: id (int)
Return type:: str

FindPageByName(self, page: str)¶

Returns page’s URL based on its (file)name.

Parameters:: page (string)
Return type:: str

GetBookRecArray(self)¶

Returns array with help books info.

Return type:: HtmlBookRecArray

GetContentsArray(self)¶

Returns reference to array with contents entries.

Return type:: HtmlHelpDataItems

GetIndexArray(self)¶

Returns reference to array with index entries.

Return type:: HtmlHelpDataItems

SetTempDir(self, path: str)¶

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.)

Parameters:: path (string)
Return type:: None

Properties¶

BookRecArray¶: See GetBookRecArray

ContentsArray¶: See GetContentsArray

IndexArray¶: See GetIndexArray

Navigation