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::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::AddToolbarButtons

wxHtmlHelpFrame::wxHtmlHelpFrame

wxHtmlHelpFrame(wxHtmlHelpData* data = NULL)

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

Constructor.

style is combination of these flags:

wxHF_TOOLBAR	Help frame has toolbar.
wxHF_FLAT_TOOLBAR	Help frame has toolbar with flat buttons (aka coolbar).
wxHF_CONTENTS	Help frame has contents panel.
wxHF_INDEX	Help frame has index panel.
wxHF_SEARCH	Help frame has search panel.
wxHF_BOOKMARKS	Help frame has bookmarks controls.
wxHF_OPEN_FILES	Allow user to open arbitrary HTML document.
wxHF_PRINT	Toolbar contains "print" button.
wxHF_MERGE_BOOKS	Contents pane does not show book nodes. All books are merged together and appear as single book to the user.
wxHF_ICONS_BOOK	All nodes in contents pane have a book icon. This is how Microsoft's HTML help viewer behaves.
wxHF_ICONS_FOLDER	Book nodes in contents pane have a book icon, book's sections have a folder icon. This is the default.
wxHF_ICONS_BOOK_CHAPTER	Both book nodes and nodes of top-level sections of a book (i.e. chapters) have a book icon, all other sections (sections, subsections, ...) have a folder icon.
wxHF_DEFAULT_STYLE	wxHF_TOOLBAR | wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH | wxHF_BOOKMARKS | wxHF_PRINT

wxHtmlHelpFrame::Create

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

Creates the frame. See the constructor for parameters description.

wxHtmlHelpFrame::CreateContents

void CreateContents(bool show_progress = false)

Creates contents panel. (May take some time.)

wxHtmlHelpFrame::CreateIndex

void CreateIndex(bool show_progress = false)

Creates index panel. (May take some time.)

wxHtmlHelpFrame::CreateSearch

void CreateSearch()

Creates search panel.

wxHtmlHelpFrame::Display

bool Display(const wxString& x)

bool Display(const int id)

Displays page x. If not found it will give the user the 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.

wxHtmlHelpFrame::DisplayContents

bool DisplayContents()

Displays contents panel.

wxHtmlHelpFrame::DisplayIndex

bool DisplayIndex()

Displays index panel.

wxHtmlHelpFrame::GetData

wxHtmlHelpData* GetData()

Return wxHtmlHelpData object.

wxHtmlHelpFrame::KeywordSearch

bool KeywordSearch(const wxString& keyword, wxHelpSearchMode mode = wxHELP_SEARCH_ALL)

Search for given keyword. Optionally it searches through the index (mode = wxHELP_SEARCH_INDEX), default the content (mode = wxHELP_SEARCH_ALL).

wxHtmlHelpFrame::ReadCustomization

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

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

wxHtmlHelpFrame::RefreshLists

void RefreshLists(bool show_progress = false)

Refresh all panels. This is necessary if a new book was added.

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::UseConfig

void UseConfig(wxConfigBase* config, const wxString& rootpath = wxEmptyString)

Add books to search choice panel.

wxHtmlHelpFrame::WriteCustomization

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

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

wxHtmlHelpFrame::AddToolbarButtons

virtual void AddToolbarButtons(wxToolBar *toolBar, int style)

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

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

See samples/html/helpview for an example.