wx.html.HtmlHelpData

Inheritance diagram for wx.html.HtmlHelpData:

Description

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.

Derived From

• wx.Object

Methods Summary

• __init__
• AddBook
• FindPageById
• FindPageByName
• GetBookRecArray
• SetTempDir

Properties Summary

• BookRecArray

Class API

Methods

__init__()

No docstrings available for this method.

---

AddBook(book)

Adds new book.

book 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 (string)

Returns:

bool

---

FindPageById(id)

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

Parameters:

• id (int)

Returns:

string

---

FindPageByName(page)

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

Parameters:

• page (string)

Returns:

string

---

GetBookRecArray()

Returns array with help books info.

Returns:

wx.html.HtmlBookRecArray

---

SetTempDir(path)

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

---

Properties

BookRecArray

See GetBookRecArray