Doc tweaks

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

diff --git a/docs/latex/wx/hthlpfrm.tex b/docs/latex/wx/hthlpfrm.tex
index 1e4f412867b2c1ec278471560c98f3aa28cb893c..bdf512fed1a0cf4df22da9f60eade4f4804e0403 100644 (file)
--- a/docs/latex/wx/hthlpfrm.tex
+++ b/docs/latex/wx/hthlpfrm.tex
@@ -62,13 +62,13 @@ for parameters description.
 
 \membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents}
 
 
 \membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents}
 

-\func{void}{CreateContents}{\param{bool }{show\_progress = FALSE}}
+\func{void}{CreateContents}{\param{bool }{show\_progress = false}}

 
 Creates contents panel. (May take some time.)
 
 \membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex}
 
 
 Creates contents panel. (May take some time.)
 
 \membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex}
 

-\func{void}{CreateIndex}{\param{bool }{show\_progress = FALSE}}
+\func{void}{CreateIndex}{\param{bool }{show\_progress = false}}

 
 Creates index panel. (May take some time.)
 
 
 Creates index panel. (May take some time.)
 


@@ -121,9 +121,10 @@ Return wxHtmlHelpData object.
 
 \membersection{wxHtmlHelpFrame::KeywordSearch}\label{wxhtmlhelpframekeywordsearch}
 
 
 \membersection{wxHtmlHelpFrame::KeywordSearch}\label{wxhtmlhelpframekeywordsearch}
 

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

 
 

-Search for given keyword.
+Search for given keyword. Optionally it searches through the index (mode =
+wxHELP\_SEARCH\_INDEX), default the content (mode = wxHELP\_SEARCH\_ALL).

 
 \membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization}
 
 
 \membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization}
 


@@ -133,7 +134,7 @@ Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCus
 
 \membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists}
 
 
 \membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists}
 

-\func{void}{RefreshLists}{\param{bool }{show\_progress = FALSE}}
+\func{void}{RefreshLists}{\param{bool }{show\_progress = false}}

 
 Refresh all panels. This is necessary if a new book was added.
 
 
 Refresh all panels. This is necessary if a new book was added.