wxHtmlHelpData

This class is used by wxHtmlHelpController and wxHtmlHelpFrame 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

wxObject

Include files

<wx/html/helpdata.h>



wxHtmlHelpData::wxHtmlHelpData



wxHtmlHelpData(void)

Constructor.



wxHtmlHelpData::AddBook



bool AddBook(const wxString& book_url)

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.



wxHtmlHelpData::FindPageById



wxString FindPageById(int id)

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



wxHtmlHelpData::FindPageByName



wxString FindPageByName(const wxString& page)

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



wxHtmlHelpData::GetBookRecArray



const wxHtmlBookRecArray& GetBookRecArray(void)

Returns array with help books info.



wxHtmlHelpData::GetContentsArray



const wxHtmlHelpDataItems& GetContentsArray(void)

Returns reference to array with contents entries.



wxHtmlHelpData::GetIndexArray



const wxHtmlHelpDataItems& GetIndexArray(void)

Returns reference to array with index entries.



wxHtmlHelpData::SetTempDir



void SetTempDir(const wxString& 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.)

ymasuda 平成17年11月19日