Provide a wxDirSelectorPromptStr

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

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index 974c2fbb7115a3229d356d4d1ba6200bb3861b92..01ef4f3eb1df50bb28037e902a653274ba56f011 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).
@@ -72,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}
@@ -84,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.
@@ -183,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}}
@@ -234,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}}