Table Of Contents

Previous topic

HeaderColumnSimple

Next topic

HelpControllerHelpProvider

This Page

phoenix_title HelpControllerBase

This is the abstract base class a family of classes by which applications may invoke a help viewer to provide on-line help.

A help controller allows an application to display help, at the contents or at a particular topic, and shut the help program down on termination. This avoids proliferation of many instances of the help viewer whenever the user requests a different topic via the application’s menus or buttons.

Typically, an application will create a help controller instance when it starts, and immediately call HelpController.Initialize to associate a filename with it. The help viewer will only get run, however, just before the first call to display something.

See also

HelpController, HtmlHelpController, HTML Overview


class_hierarchy Inheritance Diagram

Inheritance diagram for class HelpControllerBase

Inheritance diagram of HelpControllerBase


sub_classes Known Subclasses

ExtHelpController, HelpController, HtmlHelpController


method_summary Methods Summary

__init__ Constructs a help instance object, but does not invoke the help viewer.
DisplayBlock If the help viewer is not running, runs it and displays the file at the given block number.
DisplayContents If the help viewer is not running, runs it and displays the contents.
DisplayContextPopup Displays the section as a popup window using a context id.
DisplaySection If the help viewer is not running, runs it and displays the given section.
DisplayTextPopup Displays the text in a popup window, if possible.
GetFrameParameters For HtmlHelpController, returns the latest frame size and position settings and whether a new frame is drawn with each invocation.
GetParentWindow Returns the window to be used as the parent for the help window.
Initialize Initializes the help instance with a help filename, and optionally a server socket number if using Help (now obsolete).
KeywordSearch If the help viewer is not running, runs it, and searches for sections matching the given keyword.
LoadFile If the help viewer is not running, runs it and loads the given file.
OnQuit Overridable member called when this application’s viewer is quit by the user.
Quit If the viewer is running, quits it by disconnecting.
SetFrameParameters For HtmlHelpController, the title is set (with s indicating the page title) and also the size and position of the frame if the frame is already open.
SetParentWindow Sets the window to be used as the parent for the help window.
SetViewer Sets detailed viewer information.

api Class API



class HelpControllerBase(Object)

This is the abstract base class a family of classes by which applications may invoke a help viewer to provide on-line help.

Possible constructors:

HelpControllerBase(parentWindow=None)

Methods



__init__(self, parentWindow=None)

Constructs a help instance object, but does not invoke the help viewer.

If you provide a window, it will be used by some help controller classes, such as CHMHelpController, WinHelpController and HtmlHelpController, as the parent for the help window instead of the value of App.GetTopWindow .

You can also change the parent window later with SetParentWindow .

Parameters:parentWindow (Window) –


DisplayBlock(self, blockNo)

If the help viewer is not running, runs it and displays the file at the given block number.

  • WinHelp: Refers to the context number.
  • MS HTML Help: Refers to the context number.
  • External HTML help: the same as for DisplaySection .
  • `` HtmlHelpController: `` sectionNo is an identifier as specified in the Help Files Format.
Parameters:blockNo (long) –
Return type:bool

Deprecated since version 2.9.4: This function is for backward compatibility only, and applications should use DisplaySection instead.



DisplayContents(self)

If the help viewer is not running, runs it and displays the contents.

Return type:bool


DisplayContextPopup(self, contextId)

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

Returns False if unsuccessful or not implemented.

Parameters:contextId (int) –
Return type:bool


DisplaySection(self, *args, **kw)

overload Overloaded Implementations:



DisplaySection (self, section)

If the help viewer is not running, runs it and displays the given section.

The interpretation of section differs between help viewers. For most viewers, this call is equivalent to KeywordSearch. For MS HTML Help, HTML help and external HTML help, if section has a .htm or .html extension, that HTML file will be displayed; otherwise a keyword search is done.

Parameters:section (string) –
Return type:bool



DisplaySection (self, sectionNo)

If the help viewer is not running, runs it and displays the given section.

  • WinHelp, MS HTML Help sectionNo is a context id.
  • External HTML help: ExtHelpController implements sectionNo as an id in a map file, which is of the form:
  • `` HtmlHelpController: `` sectionNo is an identifier as specified in the Help Files Format. See also the help sample for notes on how to specify section numbers for various help file formats.
Parameters:sectionNo (int) –
Return type:bool





DisplayTextPopup(self, text, pos)

Displays the text in a popup window, if possible.

Returns False if unsuccessful or not implemented.

Parameters:
  • text (string) –
  • pos (Point) –
Return type:

bool



GetFrameParameters(self)

For HtmlHelpController, returns the latest frame size and position settings and whether a new frame is drawn with each invocation.

For all other help controllers, this function does nothing and just returns None.

The most recent frame size.

The most recent frame position.

True if a new frame is drawn with each invocation.

Return type:tuple
Returns:( Frame, size, pos, newFrameEachTime )


GetParentWindow(self)

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

This window is used by CHMHelpController, WinHelpController and HtmlHelpController.

Return type: Window


Initialize(self, *args, **kw)

Initializes the help instance with a help filename, and optionally a server socket number if using Help (now obsolete).

Does not invoke the help viewer. This must be called directly after the help instance object is created and before any attempts to communicate with the viewer.

You may omit the file extension and a suitable one will be chosen. For HtmlHelpController, the extensions zip, htb and hhp will be appended while searching for a suitable file. For WinHelp, the hlp extension is appended.


overload Overloaded Implementations:



Initialize (self, file)

Parameters:file (string) –
Return type:bool



Initialize (self, file, server)

Parameters:
  • file (string) –
  • server (int) –
Return type:

bool





KeywordSearch(self, keyWord, mode=HELP_SEARCH_ALL)

If the help viewer is not running, runs it, and searches for sections matching the given keyword.

If one match is found, the file is displayed at this section. The optional parameter allows to search the index (HELP_SEARCH_INDEX) but this currently is only supported by the HtmlHelpController.

  • WinHelp, MS HTML Help: If more than one match is found, the first topic is displayed.
  • External HTML help, simple HTML help: If more than one match is found, a choice of topics is displayed.
  • `` HtmlHelpController: `` see HtmlHelpController.KeywordSearch .
Parameters:
Return type:

bool



LoadFile(self, file='')

If the help viewer is not running, runs it and loads the given file.

If the filename is not supplied or is empty, the file specified in Initialize is used.

If the viewer is already displaying the specified file, it will not be reloaded. This member function may be used before each display call in case the user has opened another file.

HtmlHelpController ignores this call.

Parameters:file (string) –
Return type:bool


OnQuit(self)

Overridable member called when this application’s viewer is quit by the user.

This does not work for all help controllers.



Quit(self)

If the viewer is running, quits it by disconnecting.

For Windows Help, the viewer will only close if no other application is using it.

Return type:bool


SetFrameParameters(self, title, size, pos=DefaultPosition, newFrameEachTime=False)

For HtmlHelpController, the title is set (with s indicating the page title) and also the size and position of the frame if the frame is already open.

newFrameEachTime is ignored.

For all other help controllers this function has no effect.

Parameters:
  • title (string) –
  • size (Size) –
  • pos (Point) –
  • newFrameEachTime (bool) –


SetParentWindow(self, parentWindow)

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

This is used by CHMHelpController, WinHelpController and HtmlHelpController.

Parameters:parentWindow (Window) –


SetViewer(self, viewer, flags=HELP_NETSCAPE)

Sets detailed viewer information.

So far this is only relevant to ExtHelpController. Some examples of usage:

self.help.SetViewer("kdehelp")
self.help.SetViewer("gnome-help-browser")
self.help.SetViewer("netscape", wx.HELP_NETSCAPE)
Parameters:
  • viewer (string) – This defaults to “netscape” for ExtHelpController.
  • flags (long) – This defaults to HELP_NETSCAPE for ExtHelpController, indicating that the viewer is a variant of Netscape Navigator.

Todo

modernize this function with LaunchDefaultBrowser


Properties



FrameParameters

See GetFrameParameters and SetFrameParameters



ParentWindow

See GetParentWindow and SetParentWindow