## wxHtmlHelpFrame

This class is used by wxHtmlHelpController to display help. It is an internal class and should not be used directly - except for the case when you're writing your own HTML help controller.

Derived from

wxFrame

Include files

<wx/html/helpfrm.h>

Members

wxHtmlHelpFrame::wxHtmlHelpFrame
wxHtmlHelpFrame::AddToolbarButtons
wxHtmlHelpFrame::Create
wxHtmlHelpFrame::GetController
wxHtmlHelpFrame::ReadCustomization
wxHtmlHelpFrame::SetController
wxHtmlHelpFrame::SetTitleFormat
wxHtmlHelpFrame::WriteCustomization

### wxHtmlHelpFrame::wxHtmlHelpFrame

wxHtmlHelpFrame(wxHtmlHelpData* data = NULL)

wxHtmlHelpFrame(wxWindow* parent, int wxWindowID, const wxString& title = wxEmptyString, int style = wxHF_DEFAULT_STYLE, wxHtmlHelpData* data = NULL)

Constructor. For the values of style, please see the documentation for wxHtmlHelpController.

### wxHtmlHelpFrame::AddToolbarButtons

virtual void AddToolbarButtons(wxToolBar *toolBar, int style)

You may override this virtual method to add more buttons to the help window's toolbar. toolBar is a pointer to the toolbar and style is the style flag as passed to the Create method.

wxToolBar::Realize is called immediately after returning from this function.

### wxHtmlHelpFrame::Create

bool Create(wxWindow* parent, wxWindowID id, const wxString& title = wxEmptyString, int style = wxHF_DEFAULT_STYLE)

Creates the frame. See the constructor for a description of the parameters.

### wxHtmlHelpFrame::GetController

wxHtmlHelpController* GetController() const

Returns the help controller associated with the frame.

### wxHtmlHelpFrame::ReadCustomization

void ReadCustomization(wxConfigBase* cfg, const wxString& path = wxEmptyString)

Reads the user's settings for this frame see wxHtmlHelpController::ReadCustomization)

### wxHtmlHelpFrame::SetController

void SetController(wxHtmlHelpController* contoller)

Sets the help controller associated with the frame.

### wxHtmlHelpFrame::SetTitleFormat

void SetTitleFormat(const wxString& format)

Sets the frame's title format. format must contain exactly one "%s" (it will be replaced by the page title).

### wxHtmlHelpFrame::WriteCustomization

void WriteCustomization(wxConfigBase* cfg, const wxString& path = wxEmptyString)

Saves the user's settings for this frame (see wxHtmlHelpController::WriteCustomization).