Made MSW wxSpinCtrl emit UPDATE event when validating

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

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index 405a855d7c85887f92b017d53cb0dcf0ee4520fb..01ef4f3eb1df50bb28037e902a653274ba56f011 100644 (file)
--- 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
 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
 \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}
 
 browser).
 \end{itemize}
 


@@ -33,19 +34,20 @@ 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
 \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.
 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
 recommended that you use the specific API for this class instead. Note that if you
 use .zip or .htb formats for your books, you
 \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: \verb$wxFileSystem::AddHandler(new wxZipFSHandler);$
+must add this line to your application initialization: {\tt wxFileSystem::AddHandler(new wxZipFSHandler);}

 or nothing will be shown in your help window.
 \end{itemize}
 
 or nothing will be shown in your help window.
 \end{itemize}
 


@@ -56,7 +58,7 @@ wxHelpControllerBase\\
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<wx/help.h> (wxWindows chooses the appropriate help controller class)\\
+<wx/help.h> (wxWidgets chooses the appropriate help controller class)\\

 <wx/helpbase.h> (wxHelpControllerBase class)\\
 <wx/helpwin.h> (Windows Help controller)\\
 <wx/msw/helpchm.h> (MS HTML Help controller)\\
 <wx/helpbase.h> (wxHelpControllerBase class)\\
 <wx/helpwin.h> (Windows Help controller)\\
 <wx/msw/helpchm.h> (MS HTML Help controller)\\


@@ -69,13 +71,18 @@ wxHelpControllerBase\\
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxHelpController::wxHelpController}
+\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.
 
 
 Constructs a help instance object, but does not invoke the help viewer.
 

-\membersection{wxHelpController::\destruct{wxHelpController}}
+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}
 
 
 \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}
 
 
 \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.
 
 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.


@@ -125,7 +132,7 @@ contents.
 
 Displays the section as a popup window using a context id.
 
 
 Displays the section as a popup window using a context id.
 

-Returns FALSE if unsuccessful or not implemented.
+Returns false if unsuccessful or not implemented.

 
 \membersection{wxHelpController::DisplaySection}\label{wxhelpcontrollerdisplaysection}
 
 
 \membersection{wxHelpController::DisplaySection}\label{wxhelpcontrollerdisplaysection}
 


@@ -163,7 +170,7 @@ See also the help sample for notes on how to specify section numbers for various
 
 Displays the text in a popup window, if possible.
 
 
 Displays the text in a popup window, if possible.
 

-Returns FALSE if unsuccessful or not implemented.
+Returns false if unsuccessful or not implemented.

 
 \membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
 
 
 \membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
 


@@ -182,12 +189,22 @@ and just returns NULL.
 \docparam{flags}{This defaults to wxHELP\_NETSCAPE for wxExtHelpController, indicating
 that the viewer is a variant of Netscape Navigator.}
 
 \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}
 
 \membersection{wxHelpController::KeywordSearch}\label{wxhelpcontrollerkeywordsearch}
 

-\func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}}
+\func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}}

 
 

-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.
+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. The optional parameter allows the search the index
+(wxHELP\_SEARCH\_INDEX) but this currently only supported by the
+wxHtmlHelpController.

 
 {\it WinHelp, MS HTML Help:} If more than one match is found, 
 the first topic is displayed.
 
 {\it WinHelp, MS HTML Help:} If more than one match is found, 
 the first topic is displayed.


@@ -222,7 +239,7 @@ This does not work for all help controllers.
 
 \func{virtual void}{SetFrameParameters}{\param{const wxString \& }{title},
  \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},
 
 \func{virtual void}{SetFrameParameters}{\param{const wxString \& }{title},
  \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},

- \param{bool }{newFrameEachTime = FALSE}}
+ \param{bool }{newFrameEachTime = false}}

 
 For wxHtmlHelpController, the title is set (again with \%s indicating the
 page title) and also the size and position of the frame if the frame is already
 
 For wxHtmlHelpController, the title is set (again with \%s indicating the
 page title) and also the size and position of the frame if the frame is already


@@ -230,6 +247,13 @@ open. {\it newFrameEachTime} is ignored.
 
 For all other help controllers this function has no effect.
 
 
 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}}
 \membersection{wxHelpController::SetViewer}\label{wxhelpcontrollersetviewer}
 
 \func{virtual void}{SetViewer}{\param{const wxString\& }{viewer}, \param{long}{ flags}}