X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/33b64e6f8b7cf372a569e61d7eee879217945043..5cb9148949accebddf960b1ca959f83a168883bf:/docs/latex/wx/helpinst.tex

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index 1e1b5dea87..ae62551e17 100644
--- a/docs/latex/wx/helpinst.tex
+++ b/docs/latex/wx/helpinst.tex
@@ -13,17 +13,33 @@ when it starts, and immediately call {\bf Initialize}\rtfsp
 to associate a filename with it. The help viewer will only get run, however,
 just before the first call to display something.
 
-Although all help controller classes actually derive from wxHelpControllerBase and have
-names of the form wxXXXHelpController, the
-appropriate class is aliased to the name wxHelpController for each platform.
+Most help controller classes actually derive from wxHelpControllerBase and have
+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 all other platforms, wxHelpControllerHtml is used if wxHTML is
+compiled into wxWindows; otherwise wxExtHelpController is used (for invoking an external
+browser).
+\end{itemize}
+
+The remaining help controller classess need to be named
+explicitly by an application that wishes to make use of them.
 
 There are currently the following help controller classes defined:
 
 \begin{itemize}\itemsep=0pt
 \item wxWinHelpController, for controlling Windows Help.
 \item wxExtHelpController, for controlling external browsers under Unix.
-The default browser is Netscape Navigator.
-\item wxXLPHelpController, for controlling wxHelp (from wxWindows 1).
+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
+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.
+\item wxXLPHelpController, for controlling wxHelp (from wxWindows 1). Obsolete.
 \end{itemize}
 
 \wxheading{Derived from}
@@ -37,8 +53,13 @@ wxHelpControllerBase\\
 <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/generic/helpxlp.h> (wxHelp controller)
 
+\wxheading{See also}
+
+\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, \helpref{wxHTML}{wxhtml}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxHelpController::wxHelpController}
@@ -95,7 +116,7 @@ If the help viewer is not running, runs it and displays the given section.
 
 {\it WinHelp:} {\it sectionNo} is a context id.
 
-{\it External HTML help:} wxExtHelpController implements {\it sectionNo} as an id in a map file, which is of the form:
+{\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:
 
 \begin{verbatim}
 0  wx.html             ; Index
@@ -136,6 +157,31 @@ has opened another file.
 
 Sets detailed viewer information. So far this is only relevant to wxExtHelpController.
 
+\membersection{wxHelpController::SetFrameParameters}\label{wxhelpcontrollersetframeparameters}
+\func{virtual void}{SetFrameParameters}
+{\param{const wxString \& }{title},
+ \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},
+ \param{bool }{newFrameEachTime = FALSE}}
+
+For the wxHelpControllerHtml, this allows the application to set the
+default frame title, size and position for the frame. If the title
+contains \%s, this will be replaced with the page title. If the
+parammeter newFrameEachTime is set, the controller will open a new
+help frame each time it is called. For all other help controllers this 
+function has no effect.
+
+\membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
+\func{virtual wxFrame *}{GetFrameParameters}
+{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL},
+ \param{bool *}{newFrameEachTime = NULL}}
+This reads the current settings for the help frame in the case of the
+wxHelpControllerHtml, setting the frame size, position and
+the newFrameEachTime parameters to the last values used. It also
+returns the pointer to the last opened help frame. This can be used
+for example, to automatically close the help frame on program
+shutdown. For all other help controllers, this function does nothing
+and just returns NULL.
+
 \wxheading{Parameters}
 
 \docparam{viewer}{This defaults to "netscape" for wxExtHelpController.}
