X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/69b5cec2b0993ce4cd56f2e50ab94e5ebd20069c..65baafba0e8cd74f2264b7e2f7625ff5bea84864:/docs/latex/wx/helpinst.tex diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex index 758105130c..3aa871d06b 100644 --- a/docs/latex/wx/helpinst.tex +++ b/docs/latex/wx/helpinst.tex @@ -18,9 +18,10 @@ names of the form wxXXXHelpController or wxHelpControllerXXX. An appropriate class is aliased to the name wxHelpController for each platform, as follows: \begin{itemize}\itemsep=0pt -\item On Windows, wxWinHelpController is used. +\item On desktop Windows, wxCHMHelpController is used (MS HTML Help). +\item On Windows CE, wxWinceHelpController is used. \item On all other platforms, wxHtmlHelpController is used if wxHTML is -compiled into wxWindows; otherwise wxExtHelpController is used (for invoking an external +compiled into wxWidgets; otherwise wxExtHelpController is used (for invoking an external browser). \end{itemize} @@ -33,13 +34,14 @@ There are currently the following help controller classes defined: \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 1 in setup.h and have htmlhelp.h header from Microsoft's HTML Help kit (you don't need -VC++ specific htmlhelp.lib because wxWindows loads necessary DLL at runtime and so it +VC++ specific htmlhelp.lib because wxWidgets loads necessary DLL at runtime and so it works with all compilers). \item wxBestHelpController, for controlling MS HTML Help or, if Microsoft's runtime is not available, \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}. You need to provide {\bf both} CHM and HTB versions of the help file. For 32bit Windows only. \item wxExtHelpController, for controlling external browsers under Unix. The default browser is Netscape Navigator. The 'help' sample shows its use. +\item wxWinceHelpController, for controlling a simple {\tt .htm} help controller for Windows CE applications. \item \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a sophisticated help controller using \helpref{wxHTML}{wxhtml}, in 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 @@ -56,7 +58,7 @@ wxHelpControllerBase\\ \wxheading{Include files} - (wxWindows chooses the appropriate help controller class)\\ + (wxWidgets chooses the appropriate help controller class)\\ (wxHelpControllerBase class)\\ (Windows Help controller)\\ (MS HTML Help controller)\\ @@ -69,13 +71,13 @@ wxHelpControllerBase\\ \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxHelpController::wxHelpController} +\membersection{wxHelpController::wxHelpController}\label{wxhelpcontrollerctor} \func{}{wxHelpController}{\void} Constructs a help instance object, but does not invoke the help viewer. -\membersection{wxHelpController::\destruct{wxHelpController}} +\membersection{wxHelpController::\destruct{wxHelpController}}\label{wxhelpcontrollerdtor} \func{}{\destruct{wxHelpController}}{\void}