Applied patch [ 827011 ] Event-based processing of item tooltips in wxTreeCtrl

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

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index f9898ecef46950cda042a4e1dc4ce160dea9d63c..758105130cce6f7341c5cf956a05b0d21d4ed7e5 100644 (file)
--- a/docs/latex/wx/helpinst.tex
+++ b/docs/latex/wx/helpinst.tex
@@ -43,7 +43,10 @@ The default browser is Netscape Navigator. The 'help' sample shows its use.
 \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
 \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.
+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);}
+or nothing will be shown in your help window.

 \end{itemize}
 
 \wxheading{Derived from}
 \end{itemize}
 
 \wxheading{Derived from}


@@ -122,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}
 


@@ -160,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}
 


@@ -181,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.


@@ -219,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