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).