more wxConfig and xwLog docs (sorry for the delay)

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

\section{\class{wxWinHelpController}}\label{wxwinhelpcontroller}

This class provides the means to control a WinHelp instance.
Under Windows, wxHelpController is defined to be a synonym for wxWinHelpController.

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{wxHelpControllerBase}{wxhelpcontrollerbase}

\wxheading{Include file}

{\tt <wx/help.h>}

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

\membersection{wxWinHelpController::wxWinHelpController}

\func{}{wxWinHelpController}{\void}

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

\membersection{wxWinHelpController::\destruct{wxWinHelpController}}

\func{}{\destruct{wxWinHelpController}}{\void}

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

\membersection{wxWinHelpController::Initialize}\label{wxwinhelpcontrollerinitialize}

\func{void}{Initialize}{\param{const wxString\& }{file}}

Initializes the help instance with a help filename. 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{wxWinHelpController::DisplayBlock}\label{wxwinhelpcontrollerdisplayblock}

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

\membersection{wxWinHelpController::DisplayContents}\label{wxwinhelpcontrollerdisplaycontents}

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

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

\membersection{wxWinHelpController::DisplaySection}\label{wxwinhelpcontrollerdisplaysection}

\func{bool}{DisplaySection}{\param{int}{ sectionNo}}

DisplaySection does not apply to WinHelp.

\membersection{wxWinHelpController::KeywordSearch}\label{wxwinhelpcontrollerkeywordsearch}

\func{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 first topic is displayed (Windows Help).

\membersection{wxWinHelpController::LoadFile}\label{wxwinhelpcontrollerloadfile}

\func{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{wxWinHelpController::OnQuit}\label{wxwinhelpcontrolleronquit}

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

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

Not implemented.

\membersection{wxWinHelpController::Quit}\label{wxwinhelpcontrollerquit}

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