Contents Up Previous Next

wxHelpProvider

wxHelpProvider is an abstract class used by a program implementing context-sensitive help to show the help text for the given window.

The current help provider must be explicitly set by the application using wxHelpProvider::Set().

Derived from

No base class

Include files

<wx/cshelp.h>

See also

wxContextHelp, wxContextHelpButton, wxSimpleHelpProvider, wxHelpControllerHelpProvider, wxWindow::SetHelpText, wxWindow::GetHelpText

Members

wxHelpProvider::~wxHelpProvider
wxHelpProvider::Set
wxHelpProvider::Get
wxHelpProvider::GetHelp
wxHelpProvider::ShowHelp
wxHelpProvider::AddHelp


wxHelpProvider::~wxHelpProvider

~wxHelpProvider()

Virtual destructor for any base class.


wxHelpProvider::Set

wxHelpProvider* Set(wxHelpProvider* helpProvider)

Get/set the current, application-wide help provider. Returns the previous one.


wxHelpProvider::Get

wxHelpProvider* Get()

Unlike some other classes, the help provider is not created on demand. This must be explicitly done by the application.


wxHelpProvider::GetHelp

wxString GetHelp(const wxWindowBase* window)

Gets the help string for this window. Its interpretation is dependent on the help provider except that empty string always means that no help is associated with the window.


wxHelpProvider::ShowHelp

bool ShowHelp(wxWindowBase* window)

Shows help for the given window. Uses GetHelp internally if applicable.

Returns TRUE if it was done, or FALSE if no help was available for this window.


wxHelpProvider::AddHelp

void AddHelp(wxWindowBase* window, const wxString& text)

Associates the text with the given window or id. Although all help providers have these functions to allow making wxWindow::SetHelpText work, not all of them implement the functions.

void AddHelp(wxWindowID id, const wxString& text)

This version associates the given text with all windows with this id. May be used to set the same help string for all Cancel buttons in the application, for example.