properly detect gstreamer and libxml headers and libs, reflect that wxMediaCtrl now...

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

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index 43a266c295414d2a45d9097e4b1a65318a01d145..3fe99955fc755c4eda3ce87dca469f845be3795d 100644 (file)
--- a/docs/latex/wx/helpinst.tex
+++ b/docs/latex/wx/helpinst.tex
@@ -20,7 +20,7 @@ appropriate class is aliased to the name wxHelpController for each platform, as
 \begin{itemize}\itemsep=0pt
 \item On Windows, wxWinHelpController is used.
 \item On all other platforms, wxHtmlHelpController is used if wxHTML is
 \begin{itemize}\itemsep=0pt
 \item On Windows, wxWinHelpController 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}
 
 browser).
 \end{itemize}
 


@@ -33,7 +33,7 @@ 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
 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


@@ -56,7 +56,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 +69,13 @@ wxHelpControllerBase\\
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \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.
 
 
 \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}
 
 
 \func{}{\destruct{wxHelpController}}{\void}
 


@@ -125,7 +125,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 +163,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}
 


@@ -184,10 +184,13 @@ that the viewer is a variant of Netscape Navigator.}
 
 \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 +225,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