Detailed Description

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.

Library: wxHTML

Category: Help, HTML

Public Member Functions
	wxHtmlHelpDialog (wxHtmlHelpData *data=NULL)
	wxHtmlHelpDialog (wxWindow parent, int wxWindowID, const wxString &title=wxEmptyString, int style=wxHF_DEFAULT_STYLE, wxHtmlHelpData data=NULL)
	Constructor.
virtual void	AddToolbarButtons (wxToolBar *toolBar, int style)
	You may override this virtual method to add more buttons to the help window's toolbar.
bool	Create (wxWindow *parent, wxWindowID id, const wxString &title=wxEmptyString, int style=wxHF_DEFAULT_STYLE)
	Creates the dialog.
wxHtmlHelpController *	GetController () const
	Returns the help controller associated with the dialog.
void	SetController (wxHtmlHelpController *controller)
	Sets the help controller associated with the dialog.
void	SetTitleFormat (const wxString &format)
	Sets the dialog's title format.

Constructor & Destructor Documentation

wxHtmlHelpDialog::wxHtmlHelpDialog ( wxHtmlHelpData * data = NULL )

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

Constructor.

For the possible values of style, please see wxHtmlHelpController.

virtual void wxHtmlHelpDialog::AddToolbarButtons	(	wxToolBar *	toolBar,
		int	style
	)		`[virtual]`

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.

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

Creates the dialog.

See the constructor for a description of the parameters.

wxHtmlHelpController* wxHtmlHelpDialog::GetController ( ) const

Returns the help controller associated with the dialog.

void wxHtmlHelpDialog::SetController ( wxHtmlHelpController * controller )

Sets the help controller associated with the dialog.

void wxHtmlHelpDialog::SetTitleFormat ( const wxString & format )

Sets the dialog's title format.

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