Class: Wx::HTML::HtmlBookRecord

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

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

Helper class for HtmlHelpData.

Requires:

  • USE_HELP
  • USE_HTML

Instance Method Summary collapse

Constructor Details

#initialize(bookfile, basepath, title, start) ⇒ Wx::HTML::HtmlBookRecord

Parameters:

  • bookfile (String)
  • basepath (String)
  • title (String)
  • start (String)


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

def initialize(bookfile, basepath, title, start) end

Instance Method Details

#get_base_pathString Also known as: base_path

Returns:

  • (String)


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

def get_base_path; end

#get_book_fileString Also known as: book_file

Returns:

  • (String)


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

def get_book_file; end

#get_contents_endInteger Also known as: contents_end

Returns:

  • (Integer)


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

def get_contents_end; end

#get_contents_startInteger Also known as: contents_start

Returns:

  • (Integer)


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

def get_contents_start; end

#get_full_path(page) ⇒ String Also known as: full_path

Parameters:

  • page (String)

Returns:

  • (String)


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

def get_full_path(page) end

#get_startString Also known as: start

Returns:

  • (String)


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

def get_start; end

#get_titleString Also known as: title

Returns:

  • (String)


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

def get_title; end

#set_base_path(path) ⇒ void Also known as: base_path=

This method returns an undefined value.

Parameters:

  • path (String)


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

def set_base_path(path) end

#set_contents_range(start, end_) ⇒ void

This method returns an undefined value.

Parameters:

  • start (Integer)
  • end_ (Integer)


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

def set_contents_range(start, end_) end

#set_start(start) ⇒ void Also known as: start=

This method returns an undefined value.

Parameters:

  • start (String)


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

def set_start(start) end

#set_title(title) ⇒ void Also known as: title=

This method returns an undefined value.

Parameters:

  • title (String)


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

def set_title(title) end