Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

This commit was manufactured by cvs2svn to create tag 'WX_2_2_9'.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/tags/WX_2_2_9@13364 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2002-01-04 16:15:08 +00:00
parent dc3d889d0b
commit f7f6abe24d
2324 changed files with 375095 additions and 121526 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/latex/wx/helpinst.tex
View File

@@ -31,6 +31,8 @@ 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 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
@@ -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/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)
@@ -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 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}.
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}
@@ -111,13 +118,23 @@ contents.
\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.
{\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
@@ -127,6 +144,8 @@ 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}.
See also the help sample for notes on how to specify section numbers for various help file formats.
\membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
\func{virtual wxFrame *}{GetFrameParameters}{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL},
@@ -159,10 +178,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.
{\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.
{\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}.