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);

There are a couple of ways to invoke this behaviour implicitly:

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



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(void)

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(void)

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

ymasuda 平成17年11月19日