wxHtmlHelpWindow

Implements methods from the following classes

• wxWindow

Methods

• wxHtmlHelpWindow
• AddToolbarButtons
  You may override this virtual method to add more buttons to the help window's toolbar.
• Create
  Creates the help window.
• Display
  Displays page x.
• DisplayContents
  Displays contents panel.
• DisplayIndex
  Displays index panel.
• GetData
  Returns the wxHtmlHelpData object, which is usually a pointer to the controller's data.
• KeywordSearch
  Search for given keyword.
• ReadCustomization
  Reads the user's settings for this window.
• RefreshLists
  Refresh all panels.
• UseConfig
  Associates a wxConfig object with the help window.
• WriteCustomization
  Saves the user's settings for this window.

Static Methods

wxHtmlHelpWindow

wxHtmlHelpWindow ( wxHtmlHelpData &$data=NULL )
wxHtmlHelpWindow ( wxWindow &$parent, integer $wxWindowID, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style=wxTAB_TRAVERSAL|wxBORDER_NONE, integer $helpStyle=wxHF_DEFAULT_STYLE, wxHtmlHelpData &$data=NULL )

Constructor.

AddToolbarButtons

AddToolbarButtons ( wxToolBar &$toolBar, integer $style )

You may override this virtual method to add more buttons to the help window's toolbar.

Create

bool Create ( wxWindow &$parent, integer $id, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style=wxTAB_TRAVERSAL|wxBORDER_NONE, integer $helpStyle=wxHF_DEFAULT_STYLE )

Creates the help window.

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 form takes numeric ID as the parameter (uses an extension to MS format, param name="ID" value=id).

DisplayContents

bool DisplayContents ( )

Displays contents panel.

DisplayIndex

bool DisplayIndex ( )

Displays index panel.

GetData

wxHtmlHelpData& GetData ( )

Returns the wxHtmlHelpData object, which is usually a pointer to the controller's data.

KeywordSearch

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

Search for given keyword.

ReadCustomization

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

Reads the user's settings for this window.

RefreshLists

RefreshLists ( )

Refresh all panels.

UseConfig

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

Associates a wxConfig object with the help window.

WriteCustomization

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

Saves the user's settings for this window.