wxRuby Documentation Home

# Wx::HtmlHelpData

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

Object

## Methods

- HtmlHelpData.new
- HtmlHelpData#add_book
- HtmlHelpData#find_page_by_id
- HtmlHelpData#find_page_by_name
- HtmlHelpData#get_book_rec_array
- HtmlHelpData#get_contents_array
- HtmlHelpData#get_index_array
- HtmlHelpData#set_temp_dir

### HtmlHelpData.new

### HtmlHelpData#add_book

Boolean add_book(%(arg-type)String% 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.

### HtmlHelpData#find_page_by_id

String find_page_by_id(%(arg-type)Integer% id)

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

### HtmlHelpData#find_page_by_name

String find_page_by_name(%(arg-type)String% page)

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

### HtmlHelpData#get_book_rec_array

HtmlBookRecArray get_book_rec_array()

Returns array with help books info.

### HtmlHelpData#get_contents_array

HtmlHelpDataItems get_contents_array()

Returns reference to array with contents entries.

### HtmlHelpData#get_index_array

HtmlHelpDataItems get_index_array()

Returns reference to array with index entries.

### HtmlHelpData#set_temp_dir

set_temp_dir(%(arg-type)String% 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.)

[This page automatically generated from the Textile source at 2023-06-09 00:45:31 +0000]