*** empty log message ***

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

diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex
index f7a1378b5b01f6636f018ea3d27e750ec4bf5d01..6576ca1f3ec1c3ac8f95fbf7b984b1ea3846fdd4 100644 (file)
--- a/docs/latex/wx/hthelpct.tex
+++ b/docs/latex/wx/hthelpct.tex
@@ -19,7 +19,8 @@ wxHTML uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as i
 native format. The file format is described \helpref{here}{helpformat}.
 Have a look at docs/html/ directory where sample project files are stored.
 
 native format. The file format is described \helpref{here}{helpformat}.
 Have a look at docs/html/ directory where sample project files are stored.
 

-You can use tex2rtf to generate MHHW projects (see wxHTML homepage for details).
+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:
 
 In order to use the controller in your application under Windows you must
 have the following line in your .rc file:


@@ -28,15 +29,24 @@ have the following line in your .rc file:
 #include "wx/html/msw/wxhtml.rc"
 \end{verbatim}
 
 #include "wx/html/msw/wxhtml.rc"
 \end{verbatim}
 

+\wxheading{Note}
+
+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
+{\bf hhp2cached} utility from {\it utils/hhp2cached} to create it and
+distribute the cached version together with helpfiles. See {\it samples/html/help}
+sample for demonstration of its use.
+

 \wxheading{Derived from}
 
 \wxheading{Derived from}
 

-wxEvtHandler
+\helpref{wxEvtHandler}{wxevthandler}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
 

-\func{}{wxHtmlHelpController}{\param{int }{style = wxHF_DEFAULTSTYLE}}
+\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULTSTYLE}}

 
 Constructor.
 
 
 Constructor.
 


@@ -49,13 +59,16 @@ Constructor.
 \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\_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\_PRINT}}{Toolbar contains "print" button.}

 \end{twocollist}
 
 \end{twocollist}
 

-Default value : everything enabled.
+Default value: everything but wxHF\_OPENFILES enabled.

 
 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
 
 
 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
 

-\func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show_wait_msg}}
+\func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show\_wait\_msg}}

 
 Adds book (\helpref{.hhp file}{helpformat} - HTML Help Workshop project file) into the list of loaded books.
 This must be called at least once before displaying  any help.
 
 Adds book (\helpref{.hhp file}{helpformat} - HTML Help Workshop project file) into the list of loaded books.
 This must be called at least once before displaying  any help.


@@ -137,6 +150,10 @@ 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}
 deleted when program exits.
 
 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 
+of your application. If cached files become older than corresponding .hhp
+file (e.g. if you regenerate documentation) it will be refreshed.
+

 \membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
 
 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
 \membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
 
 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}


@@ -155,9 +172,23 @@ reads and writes settings (including wxHtmlWindow's settings) when needed.
 
 The only thing you must do is create wxConfig object and call UseConfig.
 
 
 The only thing you must do is create wxConfig object and call UseConfig.
 

+If you do not use {\it UseConfig}, wxHtmlHelpController will use 
+default wxConfig object if available (for details see 
+\helpref{wxConfigBase::Get}{wxconfigbaseget} and 
+\helpref{wxConfigBase::Set}{wxconfigbaseset}).
+

 \membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
 
 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
 
 Stores controllers setting (position of window etc.)
 
 \membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
 
 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
 
 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.
+
+