.. include:: headings.inc



.. _ContextHelpButton:

==========================================================================================================================================
|phoenix_title|  **ContextHelpButton**
==========================================================================================================================================

Instances of this class may be used to add a question mark button that when pressed, puts the application into context-help mode.          

It does this by creating a :ref:`ContextHelp`  object which itself generates a  ``wxEVT_HELP``   event when the user clicks on a window. 

On Windows, you may add a question-mark icon to a dialog by use of the ``DIALOG_EX_CONTEXTHELP`` extra style, but on other platforms you will have to add a button explicitly, usually next to ``OK``, Cancel or similar buttons. 







         



.. seealso:: :ref:`BitmapButton`, :ref:`ContextHelp`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **ContextHelpButton**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/ContextHelpButton_inheritance.png" alt="Inheritance diagram of ContextHelpButton" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="427,31,501,62"/> <area shape="rect" id="node13" href="AnyButton.html" title="A class for common button functionality used as the base for the various button classes." alt="" coords="551,31,647,62"/> <area shape="rect" id="node2" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="297,31,377,62"/> <area shape="rect" id="node4" href="ContextHelpButton.html" title="Instances of this class may be used to add a question mark button that when pressed, puts the application into context-help mode." alt="" coords="984,31,1139,62"/> <area shape="rect" id="node5" href="BitmapButton.html" title="A bitmap button is a control that contains a bitmap." alt="" coords="817,31,935,62"/> <area shape="rect" id="node7" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="148,31,247,62"/> <area shape="rect" id="node9" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="16,5,88,35"/> <area shape="rect" id="node11" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,58,99,89"/> <area shape="rect" id="node15" href="Button.html" title="A button is a control that contains a text string, and is one of the most common elements of a GUI." alt="" coords="696,31,768,62"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~ContextHelpButton.__init__`                                              Constructor, creating and showing a context help button.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: ContextHelpButton(BitmapButton)

   Instances of this class may be used to add a question mark button that when pressed, puts the application into context-help mode.
   
   **Possible constructors**::

       ContextHelpButton(parent, id=ID_ANY, pos=DefaultPosition,
                         size=DefaultSize, style=BU_AUTODRAW)
       



   .. method:: __init__(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=BU_AUTODRAW)

      Constructor, creating and showing a context help button.                  




      :param `parent`: Parent window. Must not be ``None``.   
      :type `parent`: Window
      :param `id`: Button identifier. Defaults to ``ID_CONTEXT_HELP``.   
      :type `id`: int
      :param `pos`: Button position. If ``DefaultPosition``   is specified then a default position is chosen.   
      :type `pos`: Point
      :param `size`: Button size. If ``DefaultSize``   is specified then the button is sized appropriately for the question mark bitmap.   
      :type `size`: Size
      :param `style`: Window style.  
      :type `style`: long












                  



      .. note:: 

         Normally you only need pass the parent window to the constructor, and use the defaults for the remaining parameters.