Version: 2.9.4
Public Member Functions
wxHelpController Class Reference

#include </home/zeitlin/src/wx/github/interface/wx/help.h>

Inheritance diagram for wxHelpController:

Detailed Description

This is an alias for one of a family of help controller classes which is most appropriate for the current platform.

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 wxHelpController::Initialize to associate a filename with it. The help viewer will only get run, however, just before the first call to display something.

Most help controller classes actually derive from wxHelpControllerBase and have names of the form wxXXXHelpController or wxHelpControllerXXX. An appropriate class is aliased to the name wxHelpController for each platform, as follows:

The remaining help controller classes need to be named explicitly by an application that wishes to make use of them.

The following help controller classes are defined:

Library:  wxCore
Category:  Help
参照:
wxHtmlHelpController, wxHTML Overview

Public Member Functions

 wxHelpController (wxWindow *parentWindow=NULL)
 Constructs a help instance object, but does not invoke the help viewer.

List of all members.


Constructor & Destructor Documentation

wxHelpController::wxHelpController ( wxWindow parentWindow = NULL)

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

If you provide a window, it will be used by some help controller classes, such as wxCHMHelpController, wxWinHelpController and wxHtmlHelpController, as the parent for the help window instead of the value of wxApp::GetTopWindow.

You can also change the parent window later with SetParentWindow().

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines