phoenix_title wx.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 , wx.html.HtmlHelpController, HTML Overview


class_hierarchy Class Hierarchy

Inheritance diagram for class HelpControllerBase:

sub_classes Known Subclasses

wx.adv.ExtHelpController, HelpController , wx.html.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 wx.html.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.

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

Set the parameters of the frame window.

SetParentWindow

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

SetViewer

Sets detailed viewer information.


api Class API

class wx.HelpControllerBase(Object)

Possible constructors:

HelpControllerBase(parentWindow=None)

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


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 wx.html.HtmlHelpController, as the parent for the help window instead of the value of wx.App.GetTopWindow .

You can also change the parent window later with SetParentWindow .

Parameters

parentWindow (wx.Window) –



DisplayBlock(self, blockNo)

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

Parameters

blockNo (long) –

Return type

bool

Deprecated

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.

  • MS HTML Help: Pass -1 in sectionNo to display the index.

  • External HTML help: wx.adv.ExtHelpController implements sectionNo as an id in a map file, which is of the form:

  • ` wx.html.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
Return type

bool



GetFrameParameters(self)

For wx.html.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.

Return type

tuple

Returns

( wx.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 wx.html.HtmlHelpController.

Return type

wx.Window



Initialize(self, file)

Initializes the help instance with a help filename.

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 wx.html.HtmlHelpController, the extensions zip, htb and hhp will be appended while searching for a suitable file. For WinHelp, the hlp extension is appended.

Parameters

file (string) –

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 searching the index (wx``wx.HELP_SEARCH_INDEX``) but this currently is only supported by the wx.html.HtmlHelpController.

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

wx.html.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, titleFormat, size, pos=DefaultPosition, newFrameEachTime=False)

Set the parameters of the frame window.

For wx.html.HtmlHelpController, titleFormat specifies the title string format (with s being replaced by the actual page title) and size and position specify the geometry of the frame.

For all other help controllers this function has no effect.

Finally, newFrameEachTime is always ignored currently.

Parameters
  • titleFormat (string) –

  • size (wx.Size) –

  • pos (wx.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 wx.html.HtmlHelpController.

Parameters

parentWindow (wx.Window) –



SetViewer(self, viewer, flags=HELP_NETSCAPE)

Sets detailed viewer information.

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

self.help.SetViewer("kdehelp")
self.help.SetViewer("gnome-help-browser")
self.help.SetViewer("netscape", wx.HELP_NETSCAPE)
Parameters

Todo

modernize this function with wx.LaunchDefaultBrowser


Properties

FrameParameters

See GetFrameParameters and SetFrameParameters



ParentWindow

See GetParentWindow and SetParentWindow