changed wxLog::OnLog(String) to take wxString instead of wxChar* to avoid unnecessary...

[wxWidgets.git] / docs / latex / wx / helpinst.tex

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index 3fe99955fc755c4eda3ce87dca469f845be3795d..cf39127900feeb86ef1d16715c3748018201ff8d 100644 (file)
--- a/docs/latex/wx/helpinst.tex
+++ b/docs/latex/wx/helpinst.tex
@@ -18,7 +18,8 @@ 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 wxWidgets; otherwise wxExtHelpController is used (for invoking an external
 browser).
@@ -40,12 +41,13 @@ not available, \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}. You need to
 {\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
 recommended that you use the specific API for this class instead. Note that if you
 use .zip or .htb formats for your books, you
-must add this line to your application initialization: {\tt wxFileSystem::AddHandler(new wxZipFSHandler);}
+must add this line to your application initialization: {\tt wxFileSystem::AddHandler(new wxArchiveFSHandler);}
 or nothing will be shown in your help window.
 \end{itemize}
 
@@ -71,10 +73,15 @@ wxHelpControllerBase\\
 
 \membersection{wxHelpController::wxHelpController}\label{wxhelpcontrollerctor}
 
-\func{}{wxHelpController}{\void}
+\func{}{wxHelpController}{\param{wxWindow*}{ parentWindow = NULL}}
 
 Constructs a help instance object, but does not invoke the help viewer.
 
+If you provide a window, it will be used by some help controller classes, such as
+wxCHMHelpController, wxWinHelpController and wxHtmlHelpController, as the
+parent for the help window instead of the value of \helpref{wxApp::GetTopWindow}{wxappgettopwindow}. You can also change the parent window later with 
+\helpref{wxHelpController::SetParentWindow}{wxhelpcontrollersetparentwindow}.
+
 \membersection{wxHelpController::\destruct{wxHelpController}}\label{wxhelpcontrollerdtor}
 
 \func{}{\destruct{wxHelpController}}{\void}
@@ -83,9 +90,9 @@ Destroys the help instance, closing down the viewer if it is running.
 
 \membersection{wxHelpController::Initialize}\label{wxhelpcontrollerinitialize}
 
-\func{virtual void}{Initialize}{\param{const wxString\& }{file}}
+\func{virtual bool}{Initialize}{\param{const wxString\& }{file}}
 
-\func{virtual void}{Initialize}{\param{const wxString\& }{file}, \param{int}{ server}}
+\func{virtual bool}{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 (now obsolete). Does not invoke the help viewer.
@@ -182,6 +189,13 @@ and just returns NULL.
 \docparam{flags}{This defaults to wxHELP\_NETSCAPE for wxExtHelpController, indicating
 that the viewer is a variant of Netscape Navigator.}
 
+\membersection{wxHelpController::GetParentWindow}\label{wxhelpcontrollergetparentwindow}
+
+\constfunc{virtual bool}{GetParentWindow}{\void}
+
+Returns the window to be used as the parent for the help window. This window is used
+by wxCHMHelpController, wxWinHelpController and wxHtmlHelpController.
+
 \membersection{wxHelpController::KeywordSearch}\label{wxhelpcontrollerkeywordsearch}
 
 \func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}}
@@ -233,6 +247,13 @@ open. {\it newFrameEachTime} is ignored.
 
 For all other help controllers this function has no effect.
 
+\membersection{wxHelpController::SetParentWindow}\label{wxhelpcontrollersetparentwindow}
+
+\func{virtual void}{SetParentWindow}{\param{wxWindow* }{parentWindow}}
+
+Sets the window to be used as the parent for the help window. This is used
+by wxCHMHelpController, wxWinHelpController and wxHtmlHelpController.
+
 \membersection{wxHelpController::SetViewer}\label{wxhelpcontrollersetviewer}
 
 \func{virtual void}{SetViewer}{\param{const wxString\& }{viewer}, \param{long}{ flags}}