wxHtmlHelpController

Methods

• wxHtmlHelpController
  Constructor.
• AddBook
  Adds a book (i.e.
• CreateHelpDialog
  This protected virtual method may be overridden so that when specifying the wxHF_DIALOG style, the controller uses a different dialog.
• CreateHelpFrame
  This protected virtual method may be overridden so that the controller uses a different frame.
• Display
  Displays page x.
• DisplayContents
  Displays help window and focuses contents panel.
• DisplayIndex
  Displays help window and focuses index panel.
• KeywordSearch
  Displays the help window, focuses search panel and starts searching.
• ReadCustomization
  Reads the controller's setting (position of window, etc.)
• SetShouldPreventAppExit
  Sets whether the help frame should prevent application from exiting if it's the only remaining top level window.
• SetTempDir
  Sets the path for storing temporary files - cached binary versions of index and contents files.
• SetTitleFormat
  Sets format of title of the frame.
• UseConfig
  Associates the config object with the controller.
• WriteCustomization
  Stores controllers setting (position of window etc.)

wxHtmlHelpController

wxHtmlHelpController ( integer $style=wxHF_DEFAULT_STYLE, wxWindow &$parentWindow=NULL )

Constructor.

AddBook

bool AddBook ( wxFileName $bookFile, bool $showWaitMsg=false )

Adds a book (i.e.
bool AddBook ( string $bookUrl, bool $showWaitMsg=false )

Adds a book (i.e.

CreateHelpDialog

wxHtmlHelpDialog& CreateHelpDialog ( wxHtmlHelpData &$data )

This protected virtual method may be overridden so that when specifying the wxHF_DIALOG style, the controller uses a different dialog.

CreateHelpFrame

wxHtmlHelpFrame& CreateHelpFrame ( wxHtmlHelpData &$data )

This protected virtual method may be overridden so that the controller uses a different frame.

Display

bool Display ( string $x )

Displays page x.
bool Display ( integer $id )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This alternative form is used to search help contents by numeric IDs.

DisplayContents

bool DisplayContents ( )

Displays help window and focuses contents panel.

DisplayIndex

bool DisplayIndex ( )

Displays help window and focuses index panel.

KeywordSearch

bool KeywordSearch ( string $keyword, wxHelpSearchMode $mode=wxHELP_SEARCH_ALL )

Displays the help window, focuses search panel and starts searching.

ReadCustomization

ReadCustomization ( wxConfigBase &$cfg, string $path=wxEmptyString )

Reads the controller's setting (position of window, etc.)

SetShouldPreventAppExit

SetShouldPreventAppExit ( bool $enable )

Sets whether the help frame should prevent application from exiting if it's the only remaining top level window.

SetTempDir

SetTempDir ( string $path )

Sets the path for storing temporary files - cached binary versions of index and contents files.

SetTitleFormat

SetTitleFormat ( string $format )

Sets format of title of the frame.

UseConfig

UseConfig ( wxConfigBase &$config, string $rootpath=wxEmptyString )

Associates the config object with the controller.

WriteCustomization

WriteCustomization ( wxConfigBase &$cfg, string $path=wxEmptyString )

Stores controllers setting (position of window etc.)