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

Removed references to wxHelpControllerHtml from docs.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@14735 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2002-03-22 22:32:46 +00:00
parent e564aa153e
commit 2f3f48883d
1 changed files with 6 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -19,7 +19,7 @@ appropriate class is aliased to the name wxHelpController for each platform, as
\begin{itemize}\itemsep=0pt \begin{itemize}\itemsep=0pt
\item On Windows, wxWinHelpController is used. \item On Windows, wxWinHelpController is used.
\item On all other platforms, wxHelpControllerHtml is used if wxHTML is \item On all other platforms, wxHtmlHelpController is used if wxHTML is
compiled into wxWindows; otherwise wxExtHelpController is used (for invoking an external compiled into wxWindows; otherwise wxExtHelpController is used (for invoking an external
browser). browser).
\end{itemize} \end{itemize}
@@ -40,9 +40,7 @@ not available, \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}. You need to
{\bf both} CHM and HTB versions of the help file. For 32bit Windows only. {\bf both} CHM and HTB versions of the help file. For 32bit Windows only.
\item wxExtHelpController, for controlling external browsers under Unix. \item wxExtHelpController, for controlling external browsers under Unix.
The default browser is Netscape Navigator. The 'help' sample shows its use. 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 \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a sophisticated help controller using \helpref{wxHTML}{wxhtml}, in
details of use.
\item \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a more sophisticated help controller using \helpref{wxHTML}{wxhtml}, in
a similar style to the Microsoft HTML Help viewer and using some of the same files. 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 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.
@@ -60,8 +58,7 @@ wxHelpControllerBase\\
<wx/helpwin.h> (Windows Help controller)\\ <wx/helpwin.h> (Windows Help controller)\\
<wx/msw/helpchm.h> (MS HTML 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> (wxHTML based help controller: wxHtmlHelpController)
<wx/html/helpctrl.h> (advanced wxHTML based help controller: wxHtmlHelpController)
\wxheading{See also} \wxheading{See also}
@@ -94,9 +91,7 @@ any attempts to communicate with the viewer.
You may omit the file extension and a suitable one will be chosen. 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 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 a suitable file. For WinHelp, the hlp extension is appended.
standard HTML help controller), the filename is assumed to be a directory containing
the HTML files.
\membersection{wxHelpController::DisplayBlock}\label{wxhelpcontrollerdisplayblock} \membersection{wxHelpController::DisplayBlock}\label{wxhelpcontrollerdisplayblock}
@@ -147,7 +142,7 @@ If the help viewer is not running, runs it and displays the given section.
{\it WinHelp, MS HTML Help:} {\it sectionNo} is a context id. {\it WinHelp, MS HTML Help:} {\it sectionNo} is a context id.
{\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: {\it External HTML help/simple wxHTML help:} wxExtHelpController implements {\it sectionNo} as an id in a map file, which is of the form:
\begin{verbatim} \begin{verbatim}
0 wx.html ; Index 0 wx.html ; Index
@@ -172,15 +167,7 @@ Returns FALSE if unsuccessful or not implemented.
\func{virtual wxFrame *}{GetFrameParameters}{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL}, \func{virtual wxFrame *}{GetFrameParameters}{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL},
\param{bool *}{newFrameEachTime = NULL}} \param{bool *}{newFrameEachTime = NULL}}
This reads the current settings for the help frame in the case of the wxHtmlHelpController returns the frame, size and position.
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.
For all other help controllers, this function does nothing For all other help controllers, this function does nothing
and just returns NULL. and just returns NULL.
@@ -234,12 +221,6 @@ This does not work for all help controllers.
\param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition}, \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},
\param{bool }{newFrameEachTime = FALSE}} \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.
For wxHtmlHelpController, the title is set (again with \%s indicating the 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 page title) and also the size and position of the frame if the frame is already
open. {\it newFrameEachTime} is ignored. open. {\it newFrameEachTime} is ignored.