* wxStream fixes (integer/line parsing).

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

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index 40d2fafefa19e723103dba6bebb96c40d6f7dffa..1e1b5dea8764191d9d4e68dc563b82f7689396a8 100644 (file)
--- a/docs/latex/wx/helpinst.tex
+++ b/docs/latex/wx/helpinst.tex
@@ -1,11 +1,8 @@
-\section{\class{wxHelpControllerBase}}\label{wxhelpcontrollerbase}
+\section{\class{wxHelpController}}\label{wxhelpcontroller}

 
 

-This class defines the interface by which
+This is a family of classes by which

 applications may invoke a help viewer to provide on-line help.
 
 applications may invoke a help viewer to provide on-line help.
 

-Other classes derive from this class to provide actual implementations
-of help controllers.
-

 A help controller allows an application to display help, at the contents
 or at a particular topic, and shut the help program down on termination.
 This avoids proliferation of many instances of the help viewer whenever the
 A help controller allows an application to display help, at the contents
 or at a particular topic, and shut the help program down on termination.
 This avoids proliferation of many instances of the help viewer whenever the


@@ -16,86 +13,115 @@ when it starts, and immediately call {\bf Initialize}\rtfsp
 to associate a filename with it. The help viewer will only get run, however,
 just before the first call to display something.
 
 to associate a filename with it. The help viewer will only get run, however,
 just before the first call to display something.
 

-\wxheading{Derivation}
-
-\helpref{wxObject}{wxobject}
+Although all help controller classes actually derive from wxHelpControllerBase and have
+names of the form wxXXXHelpController, the
+appropriate class is aliased to the name wxHelpController for each platform.

 
 

-\wxheading{See also}
+There are currently the following help controller classes defined:

 
 

-\helpref{wxWinHelpController}{wxwinhelpcontroller}
+\begin{itemize}\itemsep=0pt
+\item wxWinHelpController, for controlling Windows Help.
+\item wxExtHelpController, for controlling external browsers under Unix.
+The default browser is Netscape Navigator.
+\item wxXLPHelpController, for controlling wxHelp (from wxWindows 1).
+\end{itemize}

 
 

-\wxheading{Include file}
+\wxheading{Derived from}

 
 

-{\tt <wx/helpbase.h>} (for just wxHelpControllerBase)
+wxHelpControllerBase\\
+\helpref{wxObject}{wxobject}

 
 

-{\tt <wx/help.h>} (to include the platform-specific controller, e.g. wxWinHelpController)
+\wxheading{Include files}

 
 

+<wx/help.h> (wxWindows chooses the appropriate help controller class)\\
+<wx/helpbase.h> (wxHelpControllerBase class)\\
+<wx/helpwin.h> (Windows Help controller)\\
+<wx/generic/helpext.h> (external HTML browser controller)
+<wx/generic/helpxlp.h> (wxHelp controller)

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxHelpControllerBase::wxHelpControllerBase}
+\membersection{wxHelpController::wxHelpController}

 
 

-\func{}{wxHelpControllerBase}{\void}
+\func{}{wxHelpController}{\void}

 
 Constructs a help instance object, but does not invoke the help viewer.
 
 
 Constructs a help instance object, but does not invoke the help viewer.
 

-\membersection{wxHelpControllerBase::\destruct{wxHelpControllerBase}}
+\membersection{wxHelpController::\destruct{wxHelpController}}

 
 

-\func{}{\destruct{wxHelpControllerBase}}{\void}
+\func{}{\destruct{wxHelpController}}{\void}

 
 Destroys the help instance, closing down the viewer if it is running.
 
 
 Destroys the help instance, closing down the viewer if it is running.
 

-\membersection{wxHelpControllerBase::Initialize}\label{wxhelpcontrollerbaseinitialize}
+\membersection{wxHelpController::Initialize}\label{wxhelpcontrollerinitialize}

 
 \func{virtual void}{Initialize}{\param{const wxString\& }{file}}
 
 \func{virtual void}{Initialize}{\param{const wxString\& }{file}, \param{int}{ server}}
 
 Initializes the help instance with a help filename, and optionally a server (socket)
 
 \func{virtual void}{Initialize}{\param{const wxString\& }{file}}
 
 \func{virtual void}{Initialize}{\param{const wxString\& }{file}, \param{int}{ server}}
 
 Initializes the help instance with a help filename, and optionally a server (socket)

-number. Does not invoke the help viewer.
+number if using wxHelp. Does not invoke the help viewer.

 This must be called directly after the help instance object is created and before
 any attempts to communicate with the viewer.
 
 You may omit the file extension and a suitable one will be chosen.
 
 This must be called directly after the help instance object is created and before
 any attempts to communicate with the viewer.
 
 You may omit the file extension and a suitable one will be chosen.
 

-\membersection{wxHelpControllerBase::DisplayBlock}\label{wxhelpcontrollerbasedisplayblock}
+\membersection{wxHelpController::DisplayBlock}\label{wxhelpcontrollerdisplayblock}

 
 \func{virtual bool}{DisplayBlock}{\param{long}{ blockNo}}
 
 If the help viewer is not running, runs it and displays the file at the given block number.
 
 \func{virtual bool}{DisplayBlock}{\param{long}{ blockNo}}
 
 If the help viewer is not running, runs it and displays the file at the given block number.

-The interpretation of {\it blockNo} differs between help viewers. If using Windows Help, this
-refers to the context number. If wxHelp, this is the wxHelp block number.

 
 

-\membersection{wxHelpControllerBase::DisplayContents}\label{wxhelpcontrollerbasedisplaycontents}
+{\it wxHelp:} this is the wxHelp block number.
+
+{\it WinHelp:} Refers to the context number.
+
+{\it External HTML help:} the same as for \helpref{wxHelpController::DisplaySection}{wxhelpcontrollerdisplaysection}.
+
+\membersection{wxHelpController::DisplayContents}\label{wxhelpcontrollerdisplaycontents}

 
 \func{virtual bool}{DisplayContents}{\void}
 
 If the help viewer is not running, runs it and displays the
 contents.
 
 
 \func{virtual bool}{DisplayContents}{\void}
 
 If the help viewer is not running, runs it and displays the
 contents.
 

-\membersection{wxHelpControllerBase::DisplaySection}\label{wxhelpcontrollerbasedisplaysection}
+\membersection{wxHelpController::DisplaySection}\label{wxhelpcontrollerdisplaysection}

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

-Sections are numbered starting from 1.

 
 

-For wxHelp, section numbers may be viewed by running wxHelp in edit mode.
+{\it wxHelp:} Sections are numbered starting from 1. Section numbers may be viewed by running wxHelp in edit mode.
+
+{\it WinHelp:} {\it sectionNo} is a context id.
+
+{\it External HTML help:} wxExtHelpController implements {\it sectionNo} as an id in a map file, which is of the form:

 
 

-DisplaySection does not apply to WinHelp.
+\begin{verbatim}
+0  wx.html             ; Index
+1  wx34.html#classref  ; Class reference
+2  wx204.html          ; Function reference
+\end{verbatim}

 
 

-\membersection{wxHelpControllerBase::KeywordSearch}\label{wxhelpcontrollerbasekeywordsearch}
+\membersection{wxHelpController::KeywordSearch}\label{wxhelpcontrollerkeywordsearch}

 
 \func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}}
 
 If the help viewer is not running, runs it, and searches for sections matching the given keyword. If one
 
 \func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}}
 
 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 more than one
-match is found, the Search dialog is displayed with the matches (wxHelp)
-or the first topic is displayed (Windows Help).
+match is found, the file is displayed at this section.

 
 

-\membersection{wxHelpControllerBase::LoadFile}\label{wxhelpcontrollerbaseloadfile}
+{\it wxHelp:} If more than one
+match is found, the Search dialog is displayed with the matches.

 
 

-\func{virtual bool}{LoadFile}{\param{const wxString\& }{file = NULL}}
+{\it WinHelp:} If more than one match is found, 
+the first topic is displayed.
+
+{\it External HTML help:} If more than one match is found, 
+a choice of topics is displayed.
+
+\membersection{wxHelpController::LoadFile}\label{wxhelpcontrollerloadfile}
+
+\func{virtual bool}{LoadFile}{\param{const wxString\& }{file = ""}}

 
 If the help viewer is not running, runs it and loads the given file.
 If the filename is not supplied or is
 
 If the help viewer is not running, runs it and loads the given file.
 If the filename is not supplied or is


@@ -104,15 +130,28 @@ already displaying the specified file, it will not be reloaded. This
 member function may be used before each display call in case the user
 has opened another file.
 
 member function may be used before each display call in case the user
 has opened another file.
 

-\membersection{wxHelpControllerBase::OnQuit}\label{wxhelpcontrollerbaseonquit}
+\membersection{wxHelpController::SetViewer}\label{wxhelpcontrollersetviewer}
+
+\func{virtual void}{SetViewer}{\param{const wxString\& }{viewer}, \param{long}{ flags}}
+
+Sets detailed viewer information. So far this is only relevant to wxExtHelpController.
+
+\wxheading{Parameters}
+
+\docparam{viewer}{This defaults to "netscape" for wxExtHelpController.}
+
+\docparam{flags}{This defaults to wxHELP\_NETSCAPE for wxExtHelpController, indicating
+that the viewer is a variant of Netscape Navigator.}
+
+\membersection{wxHelpController::OnQuit}\label{wxhelpcontrolleronquit}

 
 \func{virtual bool}{OnQuit}{\void}
 
 Overridable member called when this application's viewer is quit by the user.
 
 
 \func{virtual bool}{OnQuit}{\void}
 
 Overridable member called when this application's viewer is quit by the user.
 

-This only works for wxXLPHelpController.
+This does not work for all help controllers.

 
 

-\membersection{wxHelpControllerBase::Quit}\label{wxhelpcontrollerbasequit}
+\membersection{wxHelpController::Quit}\label{wxhelpcontrollerquit}

 
 \func{virtual bool}{Quit}{\void}
 
 
 \func{virtual bool}{Quit}{\void}