% htmlhelp.h at 02/May/99 19:58:53
%
-
\section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller}
-{\bf WARNING! This help controller has API incompatible with wxWindows
+{\bf WARNING! This help controller has an API incompatible with wxWindows
wxHelpController!}
This help controller provides easy way how to display HTML help in your
#include "wx/html/msw/wxhtml.rc"
\end{verbatim}
-
\wxheading{Derived from}
wxEvtHandler
-
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
\func{}{wxHtmlHelpController}{\void}
-
Constructor.
-
\membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
\func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
Sets format of title of the frame. Must contain exactly one "\%s"
(for title of displayed HTML page).
-
\membersection{wxHtmlHelpController::SetTempDir}\label{wxhtmlhelpcontrollersettempdir}
\func{void}{SetTempDir}{\param{const wxString\& }{path}}
that no cached data are stored). Note that these files are NOT
deleted when program exits!
-
\membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
\func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show_wait_msg}}
If {\it show_wait_msg} is TRUE then a decorationless window with progress message is displayed.
-
\membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
\func{void}{Display}{\param{const wxString\& }{x}}
This alternative form is used to search help contents by numeric IDs.
-
-
-
\membersection{wxHtmlHelpController::DisplayContents}\label{wxhtmlhelpcontrollerdisplaycontents}
\func{void}{DisplayContents}{\void}
Displays help window and focuses index panel.
-
\membersection{wxHtmlHelpController::KeywordSearch}\label{wxhtmlhelpcontrollerkeywordsearch}
\func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
IMPORTANT! KeywordSearch searches only pages listed in .htc file(s)!
(you should have all pages in contents file...)
-
\membersection{wxHtmlHelpController::UseConfig}\label{wxhtmlhelpcontrolleruseconfig}
\func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
The only thing you must do is create wxConfig object and call UseConfig.
-
\membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization}
\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
Reads controllers setting (position of window etc.)
-
\membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
\func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}