Class: Wx::ExtHelpController

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/ext_help_controller.rb,
lib/wx/doc/help_controller.rb

Overview

This class implements help via an external browser.

It requires the name of a directory containing the documentation and a file mapping numerical Section numbers to relative URLS. The map file contains two or three fields per line: numeric_id relative_URL [; comment/documentation] The numeric_id is the id used to look up the entry in display_section/DisplayBlock(). The relative_URL is a filename of an html file, relative to the help directory. The optional comment/documentation field (after a ‘;’) is used for keyword searches, so some meaningful text here does not hurt. If the documentation itself contains a ‘;’, only the part before that will be displayed in the listbox, but all of it used for search. Lines starting with ‘;’ will be ignored.

Category: HELP

See Also:

Requires:

  • USE_HELP

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(parentWindow = nil) ⇒ Wx::ExtHelpController

Parameters:



25
 
# File 'lib/wx/doc/gen/ext_help_controller.rb', line 25

def initialize(parentWindow=nil) end

Instance Method Details

#display_contents ⇒ Boolean

Display list of all help entries.

true on success

Returns:

  • (Boolean) 


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

def display_contents; end

#display_context_popup(contextId) ⇒ Boolean

Displays the section as a popup window using a context id.

Returns false if unsuccessful or not implemented.

Parameters:

  • contextId (Integer)

Returns:

  • (Boolean) 


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

def display_context_popup(contextId) end

#display_help(relativeURL) ⇒ Boolean

Call the browser using a relative URL.

Parameters:

  • relativeURL (String)

Returns:

  • (Boolean) 


66
 
# File 'lib/wx/doc/gen/ext_help_controller.rb', line 66

def display_help(relativeURL) end

#display_text_popup(text, pos) ⇒ Boolean

Displays the text in a popup window, if possible.

Returns false if unsuccessful or not implemented.

Parameters:

  • text (String)
  • pos (Array(Integer, Integer), Wx::Point)

Returns:

  • (Boolean) 


89
 
# File 'lib/wx/doc/gen/ext_help_controller.rb', line 89

def display_text_popup(text, pos) end

#get_frame_parameters ⇒ void

This method returns an undefined value.

Returns Only does something for Wx::HTML::HtmlHelpController.



20
 
# File 'lib/wx/doc/help_controller.rb', line 20

def get_frame_parameters; end

#get_parent_window ⇒ Wx::Window Also known as: parent_window

Returns the window to be used as the parent for the help window.

This window is used by CHMHelpController, WinHelpController and HTML::HtmlHelpController.

Returns:



95
 
# File 'lib/wx/doc/gen/ext_help_controller.rb', line 95

def get_parent_window; end

#init(dir) ⇒ Boolean

This must be called to tell the controller where to find the documentation.

If a locale is set, look in file/localename, i.e. If passed “/usr/local/myapp/help” and the current Locale is set to be “de”, then look in “/usr/local/myapp/help/de/” first and fall back to “/usr/local/myapp/help” if that doesn’t exist.

true on success

Parameters:

  • dir (String) —

    directory name where to fine the help files

Returns:

  • (Boolean) 


43
 
# File 'lib/wx/doc/gen/ext_help_controller.rb', line 43

def init(dir) end

#keyword_search(k, mode = Wx::HelpSearchMode::HELP_SEARCH_ALL) ⇒ Boolean

Search comment/documentation fields in map file and present a list to chose from.

true on success

Parameters:

Returns:

  • (Boolean) 


57
 
# File 'lib/wx/doc/gen/ext_help_controller.rb', line 57

def keyword_search(k, mode=Wx::HelpSearchMode::HELP_SEARCH_ALL) end

#on_quit ⇒ void

This method returns an undefined value.

Does nothing.



61
 
# File 'lib/wx/doc/gen/ext_help_controller.rb', line 61

def on_quit; end

#set_frame_parameters(titleFormat, size, pos = Wx::DEFAULT_POSITION, newFrameEachTime = false) ⇒ void

This method returns an undefined value.

Allows one to override the default settings for the help frame.

Parameters:

  • titleFormat (String)
  • size (Array(Integer, Integer), Wx::Size)
  • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
  • newFrameEachTime (Boolean) (defaults to: false) 


74
 
# File 'lib/wx/doc/gen/ext_help_controller.rb', line 74

def set_frame_parameters(titleFormat, size, pos=Wx::DEFAULT_POSITION, newFrameEachTime=false) end

#set_parent_window(parentWindow) ⇒ void Also known as: parent_window=

This method returns an undefined value.

Sets the window to be used as the parent for the help window.

This is used by CHMHelpController, WinHelpController and HTML::HtmlHelpController.

Parameters:



103
 
# File 'lib/wx/doc/gen/ext_help_controller.rb', line 103

def set_parent_window(parentWindow) end

#set_viewer(viewer = (''), flags = Wx::HELP_NETSCAPE) ⇒ void Also known as: viewer=

This method returns an undefined value.

Tell it which browser to use.

The Netscape support will check whether Netscape is already running (by looking at the .netscape/lock file in the user’s home directory) and tell it to load the page into the existing window.

Parameters:

  • viewer (String) (defaults to: ('')) —

    The command to call a browser/html viewer.

  • flags (Integer) (defaults to: Wx::HELP_NETSCAPE) —

    Set this to HELP_NETSCAPE if the browser is some variant of Netscape.



33
 
# File 'lib/wx/doc/gen/ext_help_controller.rb', line 33

def set_viewer(viewer=(''), flags=Wx::HELP_NETSCAPE) end