********************
wx.html.HtmlHelpData
********************

Inheritance diagram for `wx.html.HtmlHelpData`:

|

.. inheritance-diagram:: wx.html.HtmlHelpData

|

Description
===========

This class is used by `wx.html.HtmlHelpController <wx.html.HtmlHelpController.html>`_ and `wx.html.HtmlHelpFrame <wx.html.HtmlHelpFrame.html>`_ 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 <../Widgets/wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `AddBook <#AddBook>`_ 
* `FindPageById <#FindPageById>`_ 
* `FindPageByName <#FindPageByName>`_ 
* `GetBookRecArray <#GetBookRecArray>`_ 
* `SetTempDir <#SetTempDir>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `BookRecArray <#BookRecArray>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   `No docstrings available for this method.` 

--------


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

--------

.. method:: FindPageById(id)

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

   **Parameters:**

   * `id` (int) 

   |  

   **Returns:**

   `string` 

--------

.. method:: FindPageByName(page)

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

   **Parameters:**

   * `page` (string) 

   |  

   **Returns:**

   `string` 

--------

.. method:: GetBookRecArray()

   Returns array with help books info.

   |  

   **Returns:**

   `wx.html.HtmlBookRecArray` 

--------

.. method:: 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
^^^^^^^^^^


.. attribute:: BookRecArray

   See `GetBookRecArray <#GetBookRecArray>`_