This class is used by wxHtmlHelpController to display help. It is internal class and should not be used directly - except for the case you're writing your own HTML help controller.
Derived from
Members
wxHtmlHelpFrame::wxHtmlHelpFrame
wxHtmlHelpFrame::Create
wxHtmlHelpFrame::CreateContents
wxHtmlHelpFrame::CreateIndex
wxHtmlHelpFrame::CreateSearch
wxHtmlHelpFrame::Display
wxHtmlHelpFrame::DisplayContents
wxHtmlHelpFrame::DisplayIndex
wxHtmlHelpFrame::GetData
wxHtmlHelpFrame::KeywordSearch
wxHtmlHelpFrame::ReadCustomization
wxHtmlHelpFrame::RefreshLists
wxHtmlHelpFrame::SetTitleFormat
wxHtmlHelpFrame::UseConfig
wxHtmlHelpFrame::WriteCustomization
wxHtmlHelpFrame(wxHtmlHelpData* data = NULL)
wxHtmlHelpFrame(wxWindow* parent, int wxWindowID, const wxString& title = wxEmptyString, int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL)
Constructor.
style is combination of these flags:
wxHF_TOOLBAR | Help frame has toolbar. |
wxHF_CONTENTS | Help frame has contents panel. |
wxHF_INDEX | Help frame has index panel. |
wxHF_SEARCH | Help frame has search panel. |
bool Create(wxWindow* parent, wxWindowID id, const wxString& title = wxEmptyString, int style = wxHF_DEFAULTSTYLE)
Creates the frame.
style is combination of these flags:
wxHF_TOOLBAR | Help frame has toolbar. |
wxHF_CONTENTS | Help frame has contents panel. |
wxHF_INDEX | Help frame has index panel. |
wxHF_SEARCH | Help frame has search panel. |
void CreateContents(bool show_progress = FALSE)
Creates contents panel. (May take some time.)
void CreateIndex(bool show_progress = FALSE)
Creates index panel. (May take some time.)
void CreateSearch()
Creates search panel.
bool Display(const wxString& x)
bool Display(const int id)
Displays page x. If not found it will offect the user a choice of searching books. Looking for the page runs in these steps: 1. try to locate file named x (if x is for example "doc/howto.htm") 2. try to open starting page of book x 3. try to find x in contents (if x is for example "How To ...") 4. try to find x in index (if x is for example "How To ...")
The second form takes numeric ID as the parameter. (uses extension to MS format, <param name="ID" value=id>)
wxPython note: The second form of this method is named DisplayId in wxPython.
bool DisplayContents()
Displays contents panel.
bool DisplayIndex()
Displays index panel.
wxHtmlHelpData* GetData()
Return wxHtmlHelpData object.
bool KeywordSearch(const wxString& keyword)
Search for given keyword.
void ReadCustomization(wxConfigBase* cfg, const wxString& path = wxEmptyString)
Reads user's settings for this frame (see wxHtmlHelpController::ReadCustomization)
void RefreshLists(bool show_progress = FALSE)
Refresh all panels. This is neccessary if new book was added.
void SetTitleFormat(const wxString& format)
Sets frame's title format. format must contain exactly one "%s" (it will be replaced by page's title).
void UseConfig(wxConfigBase* config, const wxString& rootpath = wxEmptyString)
Add books to search choice panel
void WriteCustomization(wxConfigBase* cfg, const wxString& path = wxEmptyString)
Saves user's settings for this frame (see wxHtmlHelpController::WriteCustomization)