don't call wxYield() from EnsureVisible(), this is too dangerous - and unnecessary...

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

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index f0bcaaccb6ceb0e67f7ec067b1a3f3bd783624d7..7aae0d97e7ada32e36a4b62ed3613d00d729b137 100644 (file)
--- a/docs/latex/wx/helpinst.tex
+++ b/docs/latex/wx/helpinst.tex
@@ -31,6 +31,8 @@ There are currently the following help controller classes defined:
 
 \begin{itemize}\itemsep=0pt
 \item wxWinHelpController, for controlling Windows Help.
 
 \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 0 in setup.h, and link your application with Microsoft's htmlhelp.lib. Currently VC++ only.

 \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
 \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


@@ -51,6 +53,7 @@ wxHelpControllerBase\\
 <wx/help.h> (wxWindows chooses the appropriate help controller class)\\
 <wx/helpbase.h> (wxHelpControllerBase class)\\
 <wx/helpwin.h> (Windows Help controller)\\
 <wx/help.h> (wxWindows chooses the appropriate help controller class)\\
 <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/helpwxht.h> (simple wxHTML-based help controller)\\
 <wx/html/helpctrl.h> (advanced wxHTML based help controller: wxHtmlHelpController)
 <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)


@@ -98,10 +101,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 +116,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, external HTML help
+and simple wxHTML 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/simple wxHTML help:} wxExtHelpController and wxHelpControllerHtml implement {\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,6 +152,16 @@ 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},
 \membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
 
 \func{virtual wxFrame *}{GetFrameParameters}{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL},


@@ -159,10 +194,10 @@ that the viewer is a variant of Netscape Navigator.}
 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.
 

-{\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}.