added mac constants

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

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index f0bcaaccb6ceb0e67f7ec067b1a3f3bd783624d7..3fe99955fc755c4eda3ce87dca469f845be3795d 100644 (file)
--- a/docs/latex/wx/helpinst.tex
+++ b/docs/latex/wx/helpinst.tex
@@ -19,26 +19,34 @@ appropriate class is aliased to the name wxHelpController for each platform, as
 
 \begin{itemize}\itemsep=0pt
 \item On Windows, wxWinHelpController is used.
 
 \begin{itemize}\itemsep=0pt
 \item On Windows, wxWinHelpController is used.

-\item On all other platforms, wxHelpControllerHtml is used if wxHTML is
-compiled into wxWindows; otherwise wxExtHelpController is used (for invoking an external
+\item On all other platforms, wxHtmlHelpController is used if wxHTML is
+compiled into wxWidgets; otherwise wxExtHelpController is used (for invoking an external

 browser).
 \end{itemize}
 
 browser).
 \end{itemize}
 

-The remaining help controller classess need to be named
+The remaining help controller classes need to be named

 explicitly by an application that wishes to make use of them.
 
 There are currently the following help controller classes defined:
 
 \begin{itemize}\itemsep=0pt
 \item wxWinHelpController, for controlling Windows Help.
 explicitly by an application that wishes to make use of them.
 
 There are currently the following help controller classes defined:
 
 \begin{itemize}\itemsep=0pt
 \item wxWinHelpController, for controlling Windows Help.

+\item wxCHMHelpController, for controlling MS HTML Help. To use this, you need to set wxUSE\_MS\_HTML\_HELP
+to 1 in setup.h and have htmlhelp.h header from Microsoft's HTML Help kit (you don't need
+VC++ specific htmlhelp.lib because wxWidgets loads necessary DLL at runtime and so it
+works with all compilers).
+\item wxBestHelpController, for controlling MS HTML Help or, if Microsoft's runtime is
+not available, \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}. You need to provide
+{\bf both} CHM and HTB versions of the help file. For 32bit Windows only.

 \item wxExtHelpController, for controlling external browsers under Unix.
 The default browser is Netscape Navigator. The 'help' sample shows its use.
 \item wxExtHelpController, for controlling external browsers under Unix.
 The default browser is Netscape Navigator. The 'help' sample shows its use.

-\item wxHelpControllerHtml, using \helpref{wxHTML}{wxhtml} to display help. See {\tt wx/helpwxht.h} for
-details of use.
-\item \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a more sophisticated help controller using \helpref{wxHTML}{wxhtml}, in
+\item \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a sophisticated help controller using \helpref{wxHTML}{wxhtml}, in

 a similar style to the Microsoft HTML Help viewer and using some of the same files.
 Although it has an API compatible with other help controllers, it has more advanced features, so it is
 a similar style to the Microsoft HTML Help viewer and using some of the same files.
 Although it has an API compatible with other help controllers, it has more advanced features, so it is

-recommended that you use the specific API for this class instead.
+recommended that you use the specific API for this class instead. Note that if you
+use .zip or .htb formats for your books, you
+must add this line to your application initialization: {\tt wxFileSystem::AddHandler(new wxZipFSHandler);}
+or nothing will be shown in your help window.

 \end{itemize}
 
 \wxheading{Derived from}
 \end{itemize}
 
 \wxheading{Derived from}


@@ -48,12 +56,12 @@ wxHelpControllerBase\\
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<wx/help.h> (wxWindows chooses the appropriate help controller class)\\
+<wx/help.h> (wxWidgets chooses the appropriate help controller class)\\

 <wx/helpbase.h> (wxHelpControllerBase class)\\
 <wx/helpwin.h> (Windows Help controller)\\
 <wx/helpbase.h> (wxHelpControllerBase class)\\
 <wx/helpwin.h> (Windows Help controller)\\

+<wx/msw/helpchm.h> (MS HTML Help controller)\\

 <wx/generic/helpext.h> (external HTML browser controller)\\
 <wx/generic/helpext.h> (external HTML browser controller)\\

-<wx/generic/helpwxht.h> (simple wxHTML-based help controller)\\
-<wx/html/helpctrl.h> (advanced wxHTML based help controller: wxHtmlHelpController)
+<wx/html/helpctrl.h> (wxHTML based help controller: wxHtmlHelpController)

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -61,13 +69,13 @@ wxHelpControllerBase\\
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxHelpController::wxHelpController}
+\membersection{wxHelpController::wxHelpController}\label{wxhelpcontrollerctor}

 
 \func{}{wxHelpController}{\void}
 
 Constructs a help instance object, but does not invoke the help viewer.
 
 
 \func{}{wxHelpController}{\void}
 
 Constructs a help instance object, but does not invoke the help viewer.
 

-\membersection{wxHelpController::\destruct{wxHelpController}}
+\membersection{wxHelpController::\destruct{wxHelpController}}\label{wxhelpcontrollerdtor}

 
 \func{}{\destruct{wxHelpController}}{\void}
 
 
 \func{}{\destruct{wxHelpController}}{\void}
 


@@ -86,9 +94,7 @@ any attempts to communicate with the viewer.
 
 You may omit the file extension and a suitable one will be chosen. For
 wxHtmlHelpController, the extensions zip, htb and hhp will be appended while searching for
 
 You may omit the file extension and a suitable one will be chosen. For
 wxHtmlHelpController, the extensions zip, htb and hhp will be appended while searching for

-a suitable file. For WinHelp, the hlp extension is appended. For wxHelpControllerHtml (the
-standard HTML help controller), the filename is assumed to be a directory containing
-the HTML files.
+a suitable file. For WinHelp, the hlp extension is appended.

 
 \membersection{wxHelpController::DisplayBlock}\label{wxhelpcontrollerdisplayblock}
 
 
 \membersection{wxHelpController::DisplayBlock}\label{wxhelpcontrollerdisplayblock}
 


@@ -98,10 +104,14 @@ If the help viewer is not running, runs it and displays the file at the given bl
 
 {\it WinHelp:} Refers to the context number.
 
 
 {\it WinHelp:} Refers to the context number.
 

+{\it MS HTML Help:} Refers to the context number.
+

 {\it External HTML help:} the same as for \helpref{wxHelpController::DisplaySection}{wxhelpcontrollerdisplaysection}.
 
 {\it wxHtmlHelpController:} {\it sectionNo} is an identifier as specified in the {\tt .hhc} file. See \helpref{Help files format}{helpformat}.
 
 {\it External HTML help:} the same as for \helpref{wxHelpController::DisplaySection}{wxhelpcontrollerdisplaysection}.
 
 {\it wxHtmlHelpController:} {\it sectionNo} is an identifier as specified in the {\tt .hhc} file. See \helpref{Help files format}{helpformat}.
 

+This function is for backward compatibility only, and applications should use \helpref{wxHelpController}{wxhelpcontrollerdisplaysection} instead.
+

 \membersection{wxHelpController::DisplayContents}\label{wxhelpcontrollerdisplaycontents}
 
 \func{virtual bool}{DisplayContents}{\void}
 \membersection{wxHelpController::DisplayContents}\label{wxhelpcontrollerdisplaycontents}
 
 \func{virtual bool}{DisplayContents}{\void}


@@ -109,15 +119,33 @@ If the help viewer is not running, runs it and displays the file at the given bl
 If the help viewer is not running, runs it and displays the
 contents.
 
 If the help viewer is not running, runs it and displays the
 contents.
 

+\membersection{wxHelpController::DisplayContextPopup}\label{wxhelpcontrollerdisplaycontextpopup}
+
+\func{virtual bool}{DisplayContextPopup}{\param{int }{contextId}}
+
+Displays the section as a popup window using a context id.
+
+Returns false if unsuccessful or not implemented.
+

 \membersection{wxHelpController::DisplaySection}\label{wxhelpcontrollerdisplaysection}
 
 \membersection{wxHelpController::DisplaySection}\label{wxhelpcontrollerdisplaysection}
 

+\func{virtual bool}{DisplaySection}{\param{const wxString\&}{ section}}
+
+If the help viewer is not running, runs it and displays the given section.
+
+The interpretation of {\it section} differs between help viewers. For most viewers,
+this call is equivalent to KeywordSearch. For MS HTML Help, wxHTML help and external HTML help,
+if {\it section} has a .htm
+or .html extension, that HTML file will be displayed; otherwise
+a keyword search is done.
+

 \func{virtual bool}{DisplaySection}{\param{int}{ sectionNo}}
 
 If the help viewer is not running, runs it and displays the given section.
 
 \func{virtual bool}{DisplaySection}{\param{int}{ sectionNo}}
 
 If the help viewer is not running, runs it and displays the given section.
 

-{\it WinHelp:} {\it sectionNo} is a context id.
+{\it WinHelp, MS HTML Help} {\it sectionNo} is a context id.

 
 

-{\it External HTML help/wxHTML based help:} wxExtHelpController and wxHelpControllerHtml implement {\it sectionNo} as an id in a map file, which is of the form:
+{\it External HTML help:} wxExtHelpController implements {\it sectionNo} as an id in a map file, which is of the form:

 
 \begin{verbatim}
 0  wx.html             ; Index
 
 \begin{verbatim}
 0  wx.html             ; Index


@@ -127,20 +155,22 @@ If the help viewer is not running, runs it and displays the given section.
 
 {\it wxHtmlHelpController:} {\it sectionNo} is an identifier as specified in the {\tt .hhc} file. See \helpref{Help files format}{helpformat}.
 
 
 {\it wxHtmlHelpController:} {\it sectionNo} is an identifier as specified in the {\tt .hhc} file. See \helpref{Help files format}{helpformat}.
 

+See also the help sample for notes on how to specify section numbers for various help file formats.
+
+\membersection{wxHelpController::DisplayTextPopup}\label{wxhelpcontrollerdisplaytextpopup}
+
+\func{virtual bool}{DisplayTextPopup}{\param{const wxString\&}{ text}, \param{const wxPoint\& }{pos}}
+
+Displays the text in a popup window, if possible.
+
+Returns false if unsuccessful or not implemented.
+

 \membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
 
 \func{virtual wxFrame *}{GetFrameParameters}{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL},
  \param{bool *}{newFrameEachTime = NULL}}
 
 \membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
 
 \func{virtual wxFrame *}{GetFrameParameters}{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL},
  \param{bool *}{newFrameEachTime = NULL}}
 

-This reads the current settings for the help frame in the case of the
-wxHelpControllerHtml, setting the frame size, position and
-the newFrameEachTime parameters to the last values used. It also
-returns the pointer to the last opened help frame. This can be used
-for example, to automatically close the help frame on program
-shutdown.
-
-wxHtmlHelpController returns the frame,
-size and position.
+wxHtmlHelpController returns the frame, size and position.

 
 For all other help controllers, this function does nothing
 and just returns NULL.
 
 For all other help controllers, this function does nothing
 and just returns NULL.


@@ -154,15 +184,18 @@ that the viewer is a variant of Netscape Navigator.}
 
 \membersection{wxHelpController::KeywordSearch}\label{wxhelpcontrollerkeywordsearch}
 
 
 \membersection{wxHelpController::KeywordSearch}\label{wxhelpcontrollerkeywordsearch}
 

-\func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}}
+\func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}}

 
 

-If the help viewer is not running, runs it, and searches for sections matching the given keyword. If one
-match is found, the file is displayed at this section.
+If the help viewer is not running, runs it, and searches for sections matching
+the given keyword. If one match is found, the file is displayed at this
+section. The optional parameter allows the search the index
+(wxHELP\_SEARCH\_INDEX) but this currently only supported by the
+wxHtmlHelpController.

 
 

-{\it WinHelp:} If more than one match is found, 
+{\it WinHelp, MS HTML Help:} If more than one match is found, 

 the first topic is displayed.
 
 the first topic is displayed.
 

-{\it External HTML help:} If more than one match is found, 
+{\it External HTML help, simple wxHTML help:} If more than one match is found, 

 a choice of topics is displayed.
 
 {\it wxHtmlHelpController:} see \helpref{wxHtmlHelpController::KeywordSearch}{wxhtmlhelpcontrollerkeywordsearch}.
 a choice of topics is displayed.
 
 {\it wxHtmlHelpController:} see \helpref{wxHtmlHelpController::KeywordSearch}{wxhtmlhelpcontrollerkeywordsearch}.


@@ -192,13 +225,7 @@ This does not work for all help controllers.
 
 \func{virtual void}{SetFrameParameters}{\param{const wxString \& }{title},
  \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},
 
 \func{virtual void}{SetFrameParameters}{\param{const wxString \& }{title},
  \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},

- \param{bool }{newFrameEachTime = FALSE}}
-
-For wxHelpControllerHtml, this allows the application to set the
-default frame title, size and position for the frame. If the title
-contains \%s, this will be replaced with the page title. If the
-parameter newFrameEachTime is set, the controller will open a new
-help frame each time it is called.
+ \param{bool }{newFrameEachTime = false}}

 
 For wxHtmlHelpController, the title is set (again with \%s indicating the
 page title) and also the size and position of the frame if the frame is already
 
 For wxHtmlHelpController, the title is set (again with \%s indicating the
 page title) and also the size and position of the frame if the frame is already