wxContextHelp

This class changes the cursor to a query and puts the application into a 'context-sensitive help mode'. When the user left-clicks on a window within the specified window, a wxEVT_HELP event is sent to that control, and the application may respond to it by popping up some help.

For example:

  wxContextHelp contextHelp(myWindow);

• Use the wxDIALOG_EX_CONTEXTHELP style for a dialog (Windows only). This will put a question mark in the titlebar, and Windows will put the application into context-sensitive help mode automatically, with further programming.
• Create a wxContextHelpButton, whose predefined behaviour is to create a context help object. Normally you will write your application so that this button is only added to a dialog for non-Windows platforms (use wxDIALOG_EX_CONTEXTHELP on Windows).

Note that on Mac OS X, the cursor does not change when in context-sensitive help mode.

Derived from

wxObject

Include files

<wx/cshelp.h>

See also

wxHelpEvent, wxHelpController, wxContextHelpButton

Members

wxContextHelp::wxContextHelp
wxContextHelp::~wxContextHelp
wxContextHelp::BeginContextHelp
wxContextHelp::EndContextHelp

wxContextHelp::wxContextHelp

wxContextHelp(wxWindow* window = NULL, bool doNow = true)

Constructs a context help object, calling BeginContextHelp if doNow is true (the default).

If window is NULL, the top window is used.

wxContextHelp::~wxContextHelp

~wxContextHelp()

Destroys the context help object.

wxContextHelp::BeginContextHelp

bool BeginContextHelp(wxWindow* window = NULL)

Puts the application into context-sensitive help mode. window is the window which will be used to catch events; if NULL, the top window will be used.

Returns true if the application was successfully put into context-sensitive help mode. This function only returns when the event loop has finished.

wxContextHelp::EndContextHelp

bool EndContextHelp()

Ends context-sensitive help mode. Not normally called by the application.