+%
+% automatically generated by HelpGen from
+% helpfrm.h at 24/Oct/99 18:03:10
+%
+
+
+\section{\class{wxHtmlHelpFrame}}\label{wxhtmlhelpframe}
+
+This class is used by \helpref{wxHtmlHelpController}{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.
+
+
+\wxheading{Derived from}
+
+\helpref{wxFrame}{wxframe}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+
+\membersection{wxHtmlHelpFrame::wxHtmlHelpFrame}\label{wxhtmlhelpframewxhtmlhelpframe}
+
+\func{}{wxHtmlHelpFrame}{\param{wxHtmlHelpData* }{data = NULL}}
+
+\func{}{wxHtmlHelpFrame}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}, \param{wxHtmlHelpData* }{data = NULL}}
+
+Constructor.
+
+{\it style} is combination of these flags:
+
+\begin{twocollist}
+\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
+\twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
+\twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
+\twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
+\end{twocollist}
+
+
+\membersection{wxHtmlHelpFrame::Create}\label{wxhtmlhelpframecreate}
+
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}}
+
+Creates the frame.
+
+{\it style} is combination of these flags:
+
+\begin{twocollist}
+\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
+\twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
+\twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
+\twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
+\end{twocollist}
+
+
+
+\membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents}
+
+\func{void}{CreateContents}{\param{bool }{show\_progress = FALSE}}
+
+Creates contents panel. (May take some time.)
+
+
+\membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex}
+
+\func{void}{CreateIndex}{\param{bool }{show\_progress = FALSE}}
+
+Creates index panel. (May take some time.)
+
+
+\membersection{wxHtmlHelpFrame::CreateSearch}\label{wxhtmlhelpframecreatesearch}
+
+\func{void}{CreateSearch}{\void}
+
+Creates search panel.
+
+
+\membersection{wxHtmlHelpFrame::Display}\label{wxhtmlhelpframedisplay}
+
+\func{bool}{Display}{\param{const wxString\& }{x}}
+
+\func{bool}{Display}{\param{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>)
+
+\membersection{wxHtmlHelpFrame::DisplayContents}\label{wxhtmlhelpframedisplaycontents}
+
+\func{bool}{DisplayContents}{\void}
+
+Displays contents panel.
+
+\membersection{wxHtmlHelpFrame::DisplayIndex}\label{wxhtmlhelpframedisplayindex}
+
+\func{bool}{DisplayIndex}{\void}
+
+Displays index panel.
+
+
+\membersection{wxHtmlHelpFrame::GetData}\label{wxhtmlhelpframegetdata}
+
+\func{wxHtmlHelpData*}{GetData}{\void}
+
+Return wxHtmlHelpData object.
+
+\membersection{wxHtmlHelpFrame::KeywordSearch}\label{wxhtmlhelpframekeywordsearch}
+
+\func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
+
+Search for given keyword.
+
+
+\membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization}
+
+\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
+
+Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization})
+
+\membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists}
+
+\func{void}{RefreshLists}{\param{bool }{show\_progress = FALSE}}
+
+Refresh all panels. This is neccessary if new book was added.
+
+\membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat}
+
+\func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
+
+Sets frame's title format. {\it format} must contain exactly one "\%s"
+(it will be replaced by page's title).
+
+\membersection{wxHtmlHelpFrame::UseConfig}\label{wxhtmlhelpframeuseconfig}
+
+\func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
+
+Add books to search choice panel
+
+
+\membersection{wxHtmlHelpFrame::WriteCustomization}\label{wxhtmlhelpframewritecustomization}
+
+\func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
+
+Saves user's settings for this frame (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization})
+
+
projects / wxWidgets.git / commitdiff
