**************
wx.ContextHelp
**************

Inheritance diagram for `wx.ContextHelp`:

|

.. inheritance-diagram:: wx.ContextHelp

|

Description
===========

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 ``wx.EVT_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:

* Use the ``wx.DIALOG_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 `wx.ContextHelpButton <wx.ContextHelpButton.html>`_, 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 ``wx.DIALOG_EX_CONTEXTHELP`` on Windows).

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


.. seealso:: `wx.HelpEvent <../Events/wx.HelpEvent.html>`_, `wx.HelpController <wx.HelpController.html>`_, 
   `wx.ContextHelpButton <wx.ContextHelpButton.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.Object <wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `BeginContextHelp <#BeginContextHelp>`_ 
* `EndContextHelp <#EndContextHelp>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(window=None, doNow=True)

   Constructs a context help object, calling `BeginContextHelp <#BeginContextHelp>`_ if `doNow` is
   ``True`` (the default).
   
   If window is ``None``, the top window is used.
   
   **Parameters:**

   * `window` (`wx.Window <wx.Window.html>`_)
   * `doNow` (bool)

   |

   **Returns:**

   `wx.ContextHelp <wx.ContextHelp.html>`_
 

--------

.. method:: BeginContextHelp(window=None)

   Puts the application into context-sensitive help mode. `window` is the window which will be used to catch events; if ``None``, 
   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.

   **Parameters:**

   * `window` (`wx.Window <wx.Window.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndContextHelp()

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

   |  

   **Returns:**

   `bool`