X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0d3a69ec7039f1c77bb3c23d1bfabb13d5df223f..77436c4cbac2269e564dc4fcf4494a58feca0af4:/docs/latex/wx/hthelpct.tex?ds=sidebyside diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index 8081007380..5009daf395 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -5,9 +5,9 @@ \section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller} -{\bf WARNING! Although this class has an API compatible with other wxWindows +{\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.} +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} @@ -51,7 +51,7 @@ wxHelpControllerBase \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller} -\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULTSTYLE}} +\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULT\_STYLE}} Constructor. @@ -61,16 +61,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}} @@ -89,7 +100,7 @@ If {\it show\_wait\_msg} is TRUE then a decorationless window with progress mess \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} @@ -144,7 +155,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}