cvs debugging

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

\section{\class{wxHelpController}}\label{wxhelpcontroller}

This is a family of classes by which
applications may invoke a help viewer to provide on-line help.

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
user requests a different topic via the application's menus or buttons.

Typically, an application will create a help controller instance
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.

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.

There are currently the following help controller classes defined:

\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 wxHelpControllerHtml, using wxHTML to display help
\item wxXLPHelpController, for controlling wxHelp (from wxWindows 1).
\end{itemize}

\wxheading{Derived from}

wxHelpControllerBase\\
\helpref{wxObject}{wxobject}

\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/helpwxht.h> (wxHTML based help controller)
<wx/generic/helpxlp.h> (wxHelp controller)

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

\membersection{wxHelpController::wxHelpController}

\func{}{wxHelpController}{\void}

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

\membersection{wxHelpController::\destruct{wxHelpController}}

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

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

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

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

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

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

{\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/wxHTML based 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
1  wx34.html#classref  ; Class reference
2  wx204.html          ; Function reference
\end{verbatim}

\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
match is found, the file is displayed at this section.

{\it wxHelp:} If more than one
match is found, the Search dialog is displayed with the matches.

{\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
NULL, the file specified in {\bf Initialize} is used. If the viewer is
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.

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

\membersection{wxHelpController::SetFrameParameters}\label{wxhelpcontrollersetframeparameters}
\func{virtual void}{SetFrameParameters}
{\param{const wxString \& }{title},
 \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},
 \param{bool }{newFrameEachTime = FALSE}}

For the 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
parammeter newFrameEachTime is set, the controller will open a new
help frame each time it is called. For all other help controllers this 
function has no effect.

\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. For all other help controllers, this function does nothing
and just returns NULL.

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

This does not work for all help controllers.

\membersection{wxHelpController::Quit}\label{wxhelpcontrollerquit}

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

If the viewer is running, quits it by disconnecting.

For Windows Help, the viewer will only close if no other application is using it.