wxJavaScript

back to gui 

wxContextHelp

^{generated from ../src/mod_gui/misc/cshelp.cpp}

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.

Constants

Constructor

wxContextHelp

wxContextHelp(Window = null, 
              Now = true)
 

Name	Type	Default	Description
Window	wxWindow	null	The window that will get the wxHelpEvent . When the object is null, the top level window will be used.
Now	Boolean	true	When true (= default), the application will enter the 'context-sensitive help mode' immediately. Otherwise beginContextHelp needs to be called.

Constructs a new wxContextHelp object.

Methods

beginContextHelp

beginContextHelp(Window = null) : Boolean
 

Name	Type	Default	Description
Window	wxWindow	null	The window that will get the wxHelpEvent. When the object is null, the top level window will be used.

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

endContextHelp

endContextHelp() : Boolean
 

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