removed unused variable

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

diff --git a/docs/latex/wx/hthlpfrm.tex b/docs/latex/wx/hthlpfrm.tex
index d255a73df83a23589b45e25d54dbba317f8868f7..bdf512fed1a0cf4df22da9f60eade4f4804e0403 100644 (file)
--- a/docs/latex/wx/hthlpfrm.tex
+++ b/docs/latex/wx/hthlpfrm.tex
@@ -24,7 +24,7 @@ when you're writing your own HTML help controller.
 
 \func{}{wxHtmlHelpFrame}{\param{wxHtmlHelpData* }{data = NULL}}
 
-\func{}{wxHtmlHelpFrame}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}, \param{wxHtmlHelpData* }{data = NULL}}
+\func{}{wxHtmlHelpFrame}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}}
 
 Constructor.
 
@@ -32,38 +32,43 @@ Constructor.
 
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
+\twocolitem{\windowstyle{wxHF\_FLAT\_TOOLBAR}}{Help frame has toolbar with flat buttons (aka coolbar).}
 \twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
 \twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
 \twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
 \twocolitem{\windowstyle{wxHF\_BOOKMARKS}}{Help frame has bookmarks controls.}
-\twocolitem{\windowstyle{wxHF\_OPENFILES}}{Allow user to open arbitrary HTML document.}
+\twocolitem{\windowstyle{wxHF\_OPEN\_FILES}}{Allow user to open arbitrary HTML document.}
 \twocolitem{\windowstyle{wxHF\_PRINT}}{Toolbar contains "print" button.}
+\twocolitem{\windowstyle{wxHF\_MERGE\_BOOKS}}{Contents pane does not show
+book nodes. All books are merged together and appear as single book to the
+user.}
+\twocolitem{\windowstyle{wxHF\_ICONS\_BOOK}}{All nodes in contents pane
+have a book icon. This is how Microsoft's HTML help viewer behaves.}
+\twocolitem{\windowstyle{wxHF\_ICONS\_FOLDER}}{Book nodes in contents pane have
+a book icon, book's sections have a folder icon. This is the default.}
+\twocolitem{\windowstyle{wxHF\_ICONS\_BOOK\_CHAPTER}}{Both book nodes and
+nodes of top-level sections of a book (i.e. chapters) have a book icon,
+all other sections (sections, subsections, ...) have a folder icon.}
+\twocolitem{\windowstyle{wxHF\_DEFAULT\_STYLE}}{{\tt wxHF\_TOOLBAR | wxHF\_CONTENTS
+| wxHF\_INDEX | wxHF\_SEARCH | wxHF\_BOOKMARKS | wxHF\_PRINT}}
 \end{twocollist}
 
 \membersection{wxHtmlHelpFrame::Create}\label{wxhtmlhelpframecreate}
 
-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}}
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}}
 
-Creates the frame.
-
-{\it style} is combination of these flags:
-
-\begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
-\twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
-\twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
-\twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
-\end{twocollist}
+Creates the frame. See \helpref{the constructor}{wxhtmlhelpframewxhtmlhelpframe}
+for parameters description.
 
 \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}
 
-\func{void}{CreateIndex}{\param{bool }{show\_progress = FALSE}}
+\func{void}{CreateIndex}{\param{bool }{show\_progress = false}}
 
 Creates index panel. (May take some time.)
 
@@ -116,9 +121,10 @@ Return wxHtmlHelpData object.
 
 \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}
 
@@ -128,7 +134,7 @@ Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCus
 
 \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.