X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9704b2509ac4fd7b9fccd5299e0b377accb2b59e..81f256328c32766ebf9fca0a97b03bb53e24bc6b:/docs/latex/wx/hthelpct.tex diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index be95b150ac..9d27c285dc 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -5,11 +5,12 @@ \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} +application (see {\it test} sample). The help system is based on {\bf books} (see \helpref{AddBook}{wxhtmlhelpcontrolleraddbook}). A book is a logical section of documentation (for example "User's Guide" or "Programmer's Guide" or "C++ Reference" or "wxWindows Reference"). The help controller can handle as @@ -33,25 +34,28 @@ have the following line in your .rc file: It is strongly recommended to use preprocessed {\bf .hhp.cached} version of projects. It can be either created on-the-fly (see -\helpref{SetTempDir}{wxhtmlhelpcontrollersettempdir}) or you can use +\helpref{SetTempDir}{wxhtmlhelpcontrollersettempdir}) or you can use {\bf hhp2cached} utility from {\it utils/hhp2cached} to create it and -distribute the cached version together with helpfiles. See {\it samples/html/help} +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} - \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller} -\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULTSTYLE}} +\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULT\_STYLE}} Constructor. @@ -59,18 +63,29 @@ Constructor. {\it style} is combination of these flags: -\begin{twocollist} +\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}} @@ -85,6 +100,13 @@ recommended way. If {\it show\_wait\_msg} is TRUE then a decorationless window with progress message is displayed. +\membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe} + +\func{virtual wxHtmlHelpFrame*}{CreateHelpFrame}{\param{wxHtmlHelpData * }{data}} + +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} \func{void}{Display}{\param{const wxString\& }{x}} @@ -137,7 +159,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} @@ -152,7 +174,7 @@ Reads the controller's setting (position of window, etc.) Sets the path for storing temporary files - cached binary versions of index and contents files. These binary forms are much faster to read. Default value is empty string (empty string means -that no cached data are stored). Note that these files are {\it not} +that no cached data are stored). Note that these files are {\it not} deleted when program exits. Once created these cached files will be used in all subsequent executions @@ -188,12 +210,3 @@ default wxConfig object if available (for details see Stores controllers setting (position of window etc.) -\membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe} - -\func{virtual wxHtmlHelpFrame*}{CreateHelpFrame}{\param{wxHtmlHelpData * }{data}} - -This protected virtual method may be overriden so that the controller -uses slightly different frame. See {\it samples/html/helpview} sample for -an example. - -