More Motif stuff incl. beginnings of wxToolBar

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

\section{\class{wxHelpControllerBase}}\label{wxhelpcontrollerbase}

This class defines the interface by which
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
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.

\wxheading{Derivation}

\helpref{wxObject}{wxobject}

\wxheading{See also}

\helpref{wxWinHelpController}{wxwinhelpcontroller}

\wxheading{Include file}

{\tt <wx/helpbase.h>} (for just wxHelpControllerBase)

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


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

\membersection{wxHelpControllerBase::wxHelpControllerBase}

\func{}{wxHelpControllerBase}{\void}

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

\membersection{wxHelpControllerBase::\destruct{wxHelpControllerBase}}

\func{}{\destruct{wxHelpControllerBase}}{\void}

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

\membersection{wxHelpControllerBase::Initialize}\label{wxhelpcontrollerbaseinitialize}

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

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

\func{virtual bool}{DisplayContents}{\void}

If the help viewer is not running, runs it and displays the
contents.

\membersection{wxHelpControllerBase::DisplaySection}\label{wxhelpcontrollerbasedisplaysection}

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

DisplaySection does not apply to WinHelp.

\membersection{wxHelpControllerBase::KeywordSearch}\label{wxhelpcontrollerbasekeywordsearch}

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

\membersection{wxHelpControllerBase::LoadFile}\label{wxhelpcontrollerbaseloadfile}

\func{virtual bool}{LoadFile}{\param{const wxString\& }{file = NULL}}

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{wxHelpControllerBase::OnQuit}\label{wxhelpcontrollerbaseonquit}

\func{virtual bool}{OnQuit}{\void}

Overridable member called when this application's viewer is quit by the user.

This only works for wxXLPHelpController.

\membersection{wxHelpControllerBase::Quit}\label{wxhelpcontrollerbasequit}

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