added a more convenient version of wxFileType::GetOpenCommand()

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

diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex
index 996abf852a8cf20dd0d9a2fbf432e821380445ae..34ef6476b5fa28b4e4701e1936315dacdd828823 100644 (file)
--- a/docs/latex/wx/hthelpct.tex
+++ b/docs/latex/wx/hthelpct.tex
@@ -5,8 +5,9 @@
 
 \section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller}
 
-{\bf WARNING! This help controller has an API incompatible with wxWindows
-wxHelpController!}
+{\bf WARNING!} Although this class has an API compatible with other wxWindows
+help controllers as documented by \helpref{wxHelpController}{wxhelpcontroller}, it
+is recommended that you use the enhanced capabilities of wxHtmlHelpController's API.
 
 This help controller provides an easy way of displaying HTML help in your
 application (see {\it test} sample). The help system is based on {\bf books} 
@@ -22,13 +23,6 @@ Have a look at docs/html/ directory where sample project files are stored.
 You can use Tex2RTF to produce these files when generating HTML, if you set {\bf htmlWorkshopFiles} to {\bf true} in
 your tex2rtf.ini file.
 
-In order to use the controller in your application under Windows you must
-have the following line in your .rc file:
-
-\begin{verbatim}
-#include "wx/html/msw/wxhtml.rc"
-\end{verbatim}
-
 \wxheading{Note}
 
 It is strongly recommended to use preprocessed {\bf .hhp.cached} version of
@@ -38,9 +32,13 @@ projects. It can be either created on-the-fly (see
 distribute the cached version together with helpfiles. See {\it samples/html/help} 
 sample for demonstration of its use.
 
+\wxheading{See also}
+
+\helpref{Information about wxBestHelpController}{wxhelpcontroller}
+
 \wxheading{Derived from}
 
-\helpref{wxEvtHandler}{wxevthandler}
+wxHelpControllerBase
 
 \wxheading{Include files}
 
@@ -50,7 +48,7 @@ sample for demonstration of its use.
 
 \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
 
-\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULTSTYLE}}
+\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULT\_STYLE}}
 
 Constructor.
 
@@ -60,16 +58,27 @@ 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}
 
-Default value: everything but wxHF\_OPENFILES enabled.
-
 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
 
 \func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show\_wait\_msg}}
@@ -82,13 +91,13 @@ top-level directory. This ZIP archive must have .zip or .htb extension
 (the latter stands for "HTML book"). In other words, {\tt AddBook("help.zip")} is possible and, in fact,
 recommended way.
 
-If {\it show\_wait\_msg} is TRUE then a decorationless window with progress message is displayed.
+If {\it show\_wait\_msg} is TRUE then a decoration-less window with progress message is displayed.
 
 \membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe}
 
 \func{virtual wxHtmlHelpFrame*}{CreateHelpFrame}{\param{wxHtmlHelpData * }{data}}
 
-This protected virtual method may be overriden so that the controller
+This protected virtual method may be overridden so that the controller
 uses slightly different frame. See {\it samples/html/helpview} sample for
 an example.
 \membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
@@ -143,7 +152,7 @@ Displays help window and focuses index panel.
 Displays help window, focuses search panel and starts searching.
 Returns TRUE if the keyword was found.
 
-{\bf Important:} KeywordSearch searches only pages listed in .htc file(s).
+{\bf Important:} KeywordSearch searches only pages listed in .hhc file(s).
 You should list all pages in the contents file.
 
 \membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization}
@@ -194,4 +203,3 @@ default wxConfig object if available (for details see
 
 Stores controllers setting (position of window etc.)
 
-