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.
There are a couple of ways to invoke this behaviour implicitly:
Note that on OS X, the cursor does not change when in context-sensitive help mode.
|wxContextHelp (wxWindow *window=NULL, bool doNow=true)|
|Constructs a context help object, calling BeginContextHelp() if doNow is true (the default). More...|
|Destroys the context help object. More...|
|bool||BeginContextHelp (wxWindow *window)|
|Puts the application into context-sensitive help mode. More...|
|Ends context-sensitive help mode. More...|
|Public Member Functions inherited from wxObject|
|Default ctor; initializes to NULL the internal reference data. More...|
|wxObject (const wxObject &other)|
|Copy ctor. More...|
|virtual wxClassInfo *||GetClassInfo () const|
|This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...|
|wxObjectRefData *||GetRefData () const|
|Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...|
|bool||IsKindOf (const wxClassInfo *info) const|
|Determines whether this class is a subclass of (or the same class as) the given class. More...|
|bool||IsSameAs (const wxObject &obj) const|
|Returns true if this object has the same data pointer as obj. More...|
|void||Ref (const wxObject &clone)|
|Makes this object refer to the data in clone. More...|
|void||SetRefData (wxObjectRefData *data)|
|Sets the wxObject::m_refData pointer. More...|
|Decrements the reference count in the associated data, and if it is zero, deletes the data. More...|
|This is the same of AllocExclusive() but this method is public. More...|
|void||operator delete (void *buf)|
|The delete operator is defined for debugging versions of the library only, when the identifier |
|void *||operator new (size_t size, const wxString &filename=NULL, int lineNum=0)|
|The new operator is defined for debugging versions of the library only, when the identifier |
|Protected Member Functions inherited from wxObject|
|Ensure that this object's data is not shared with any other object. More...|
|virtual wxObjectRefData *||CreateRefData () const|
|Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...|
|virtual wxObjectRefData *||CloneRefData (const wxObjectRefData *data) const|
|Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...|
|Protected Attributes inherited from wxObject|
|Pointer to an object which is the object's reference-counted data. More...|
|wxContextHelp::wxContextHelp||(||wxWindow *||window =
Constructs a context help object, calling BeginContextHelp() if doNow is true (the default).
If window is NULL, the top window is used.
Destroys the context help object.
|bool wxContextHelp::BeginContextHelp||(||wxWindow *||window||)|
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.
Ends context-sensitive help mode.
Not normally called by the application.