Class enthought.​help.​helpviewer.​HelpViewer

Contents:
• Methods

Method summary

• __init__(self, help_file, map_file = None, hwnd = None, custom_wnd = None)
• view(self, hwnd = None, custom_wnd_name = None)
• view_id(self, id, hwnd = 0, custom_wnd_name = None)
• view_index(self, hwnd = 0, custom_wnd_name = None)
• view_page(self, page, hwnd = 0)
• view_search(self, hwnd = 0, custom_wnd_name = None)
• view_toc(self, hwnd = 0, custom_wnd_name = None)

Methods

• __init__(self, help_file, map_file = None, hwnd = None, custom_wnd = None)
• view(self, hwnd = None, custom_wnd_name = None)

  Displays the default topic with table of contents pane visible.

• view_id(self, id, hwnd = 0, custom_wnd_name = None)

  Displays the topic specified by id.

• view_index(self, hwnd = 0, custom_wnd_name = None)

  Displays the default topic with index pane visible.

• view_page(self, page, hwnd = 0)

  Supports calling a page in a help project by name, rather than ID. This function is can be used for WebHelp, if IDs are not used. For HTML Help, use view_id(), to avoid hard-coding topic filenames.

• view_search(self, hwnd = 0, custom_wnd_name = None)

  Displays the default topic with the search pane visible.

• view_toc(self, hwnd = 0, custom_wnd_name = None)

  Displays the default topic with table of contents pane visible.