\begin{itemize}\itemsep=0pt
\item wxWinHelpController, for controlling Windows Help.
+\item wxCHMHelpController, for controlling MS HTML Help. To use this, you need to set wxUSE\_MS\_HTML\_HELP
+to 0 in setup.h, and link your application with Microsoft's htmlhelp.lib. Currently VC++ only.
\item wxExtHelpController, for controlling external browsers under Unix.
The default browser is Netscape Navigator. The 'help' sample shows its use.
-\item wxHelpControllerHtml, using \helpref{wxHTML}{wxhtml} to display help. The API for this class
-is reasonably close to the wxWindows help controller API; see {\tt wx/helpwxht.h} for
+\item wxHelpControllerHtml, using \helpref{wxHTML}{wxhtml} to display help. See {\tt wx/helpwxht.h} for
details of use.
\item \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a more sophisticated help controller using \helpref{wxHTML}{wxhtml}, in
-a similar style to the Windows HTML Help viewer and using some of the same files.
-%The API is not the same as the standard API, which is why it is documented separately.
+a similar style to the Microsoft HTML Help viewer and using some of the same files.
+Although it has an API compatible with other help controllers, it has more advanced features, so it is
+recommended that you use the specific API for this class instead.
\end{itemize}
\wxheading{Derived from}
<wx/help.h> (wxWindows chooses the appropriate help controller class)\\
<wx/helpbase.h> (wxHelpControllerBase class)\\
<wx/helpwin.h> (Windows Help controller)\\
-<wx/generic/helpext.h> (external HTML browser controller)
-<wx/generic/helpwxht.h> (wxHTML based help controller)
-<wx/html/helpctrl.h> (Advanced wxHTML based help controller: wxHtmlHelpController)
+<wx/msw/helpchm.h> (MS HTML Help controller)\\
+<wx/generic/helpext.h> (external HTML browser controller)\\
+<wx/generic/helpwxht.h> (simple wxHTML-based help controller)\\
+<wx/html/helpctrl.h> (advanced wxHTML based help controller: wxHtmlHelpController)
\wxheading{See also}
\func{virtual void}{Initialize}{\param{const wxString\& }{file}, \param{int}{ server}}
-Initializes the help instance with a help filename, and optionally a server (socket)
-number if using wxHelp. Does not invoke the help viewer.
+Initializes the help instance with a help filename, and optionally a server socket
+number if using wxHelp (now obsolete). Does not invoke the help viewer.
This must be called directly after the help instance object is created and before
any attempts to communicate with the viewer.
{\it WinHelp:} Refers to the context number.
+{\it MS HTML Help:} Refers to the context number.
+
{\it External HTML help:} the same as for \helpref{wxHelpController::DisplaySection}{wxhelpcontrollerdisplaysection}.
{\it wxHtmlHelpController:} {\it sectionNo} is an identifier as specified in the {\tt .hhc} file. See \helpref{Help files format}{helpformat}.
+This function is for backward compatibility only, and applications should use \helpref{wxHelpController}{wxhelpcontrollerdisplaysection} instead.
+
\membersection{wxHelpController::DisplayContents}\label{wxhelpcontrollerdisplaycontents}
\func{virtual bool}{DisplayContents}{\void}
\membersection{wxHelpController::DisplaySection}\label{wxhelpcontrollerdisplaysection}
+\func{virtual bool}{DisplaySection}{\param{const wxString\&}{ section}}
+
+If the help viewer is not running, runs it and displays the given section.
+
+The interpretation of {\it section} differs between help viewers. For most viewers,
+this call is equivalent to KeywordSearch. For MS HTML Help, external HTML help
+and simple wxHTML help, if {\it section} has a .htm
+or .html extension, that HTML file will be displayed; otherwise
+a keyword search is done.
+
\func{virtual bool}{DisplaySection}{\param{int}{ sectionNo}}
If the help viewer is not running, runs it and displays the given section.
-{\it WinHelp:} {\it sectionNo} is a context id.
+{\it WinHelp, MS HTML Help:} {\it sectionNo} is a context id.
-{\it External HTML help/wxHTML based help:} wxExtHelpController and wxHelpControllerHtml implement {\it sectionNo} as an id in a map file, which is of the form:
+{\it External HTML help/simple wxHTML help:} wxExtHelpController and wxHelpControllerHtml implement {\it sectionNo} as an id in a map file, which is of the form:
\begin{verbatim}
0 wx.html ; Index
{\it wxHtmlHelpController:} {\it sectionNo} is an identifier as specified in the {\tt .hhc} file. See \helpref{Help files format}{helpformat}.
+See also the help sample for notes on how to specify section numbers for various help file formats.
+
\membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
\func{virtual wxFrame *}{GetFrameParameters}{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL},
If the help viewer is not running, runs it, and searches for sections matching the given keyword. If one
match is found, the file is displayed at this section.
-{\it WinHelp:} If more than one match is found,
+{\it WinHelp, MS HTML Help:} If more than one match is found,
the first topic is displayed.
-{\it External HTML help:} If more than one match is found,
+{\it External HTML help, simple wxHTML help:} If more than one match is found,
a choice of topics is displayed.
{\it wxHtmlHelpController:} see \helpref{wxHtmlHelpController::KeywordSearch}{wxhtmlhelpcontrollerkeywordsearch}.
projects / wxWidgets.git / blobdiff