Class: Wx::HTML::HtmlHelpData

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/html/html_help_data.rb

Overview

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

Category: Wx::HELP, Wx::HTML

Requires:

  • USE_HELP
  • USE_HTML

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::HTML::HtmlHelpData

Constructor.



22
 
# File 'lib/wx/doc/gen/html/html_help_data.rb', line 22

def initialize; end

Instance Method Details

#add_book(book_url) ⇒ Boolean

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)

Returns:

  • (Boolean) 


30
 
# File 'lib/wx/doc/gen/html/html_help_data.rb', line 30

def add_book(book_url) end

#find_page_by_id(id) ⇒ String

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

Parameters:

  • id (Integer)

Returns:

  • (String) 


35
 
# File 'lib/wx/doc/gen/html/html_help_data.rb', line 35

def find_page_by_id(id) end

#find_page_by_name(page) ⇒ String

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

Parameters:

  • page (String)

Returns:

  • (String) 


40
 
# File 'lib/wx/doc/gen/html/html_help_data.rb', line 40

def find_page_by_name(page) end

#get_book_rec_array ⇒ Array<Wx::HtmlBookRecord> Also known as: book_rec_array

Returns array with help books info.

Returns:

  • (Array<Wx::HtmlBookRecord>) 


44
 
# File 'lib/wx/doc/gen/html/html_help_data.rb', line 44

def get_book_rec_array; end

#get_contents_array ⇒ Array<Wx::HtmlHelpDataItem> Also known as: contents_array

Returns reference to array with contents entries.

Returns:

  • (Array<Wx::HtmlHelpDataItem>) 


49
 
# File 'lib/wx/doc/gen/html/html_help_data.rb', line 49

def get_contents_array; end

#get_index_array ⇒ Array<Wx::HtmlHelpDataItem> Also known as: index_array

Returns reference to array with index entries.

Returns:

  • (Array<Wx::HtmlHelpDataItem>) 


54
 
# File 'lib/wx/doc/gen/html/html_help_data.rb', line 54

def get_index_array; end

#set_temp_dir(path) ⇒ void Also known as: temp_dir=

This method returns an undefined value.

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) 


62
 
# File 'lib/wx/doc/gen/html/html_help_data.rb', line 62

def set_temp_dir(path) end