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.