.. include:: headings.inc



.. _HelpControllerHelpProvider:

==========================================================================================================================================
|phoenix_title|  **HelpControllerHelpProvider**
==========================================================================================================================================

:ref:`HelpControllerHelpProvider`  is an implementation of :ref:`HelpProvider`  which supports both context identifiers and plain text help strings.          

If the help text is an integer, it is passed to :meth:`HelpController.DisplayContextPopup` . Otherwise, it shows the string in a tooltip as per :ref:`SimpleHelpProvider`. If you use this with a CHMHelpController instance on windows, it will use the native style of tip window instead of :ref:`TipWindow`. 

You can use the convenience function ContextId() to convert an integer context id to a string for passing to :meth:`Window.SetHelpText` . 







         



.. seealso:: :ref:`HelpProvider`, :ref:`SimpleHelpProvider`, :ref:`ContextHelp`, :meth:`Window.SetHelpText` , :meth:`Window.GetHelpTextAtPoint`     







|

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

Inheritance diagram for class **HelpControllerHelpProvider**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/HelpControllerHelpProvider_inheritance.png" alt="Inheritance diagram of HelpControllerHelpProvider" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="SimpleHelpProvider.html" title="SimpleHelpProvider  is an implementation of HelpProvider  which supports only plain text help strings, and shows the string associated with the control (if any) in a tooltip." alt="" coords="169,5,332,35"/> <area shape="rect" id="node4" href="HelpControllerHelpProvider.html" title="HelpControllerHelpProvider  is an implementation of HelpProvider  which supports both context identifiers and plain text help strings." alt="" coords="383,5,599,35"/> <area shape="rect" id="node2" href="HelpProvider.html" title="HelpProvider  is an abstract class used by a program implementing context-sensitive help to show the help text for the given window." alt="" coords="5,5,120,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~HelpControllerHelpProvider.__init__`                                     Note that the instance doesn't own the help controller.
:meth:`~HelpControllerHelpProvider.GetHelpController`                            Returns the help controller associated with this help provider.
:meth:`~HelpControllerHelpProvider.SetHelpController`                            Sets the help controller associated with this help provider.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~HelpControllerHelpProvider.HelpController`                               See :meth:`~HelpControllerHelpProvider.GetHelpController` and :meth:`~HelpControllerHelpProvider.SetHelpController`
================================================================================ ================================================================================


|


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

.. class:: HelpControllerHelpProvider(SimpleHelpProvider)

   HelpControllerHelpProvider is an implementation of HelpProvider which supports both context identifiers and plain text help strings.
   
   **Possible constructors**::

       HelpControllerHelpProvider(hc=None)
       



   .. method:: __init__(self, hc=None)

      Note that the instance doesn't own the help controller.                  

      The help controller should be deleted separately.                  


      :param `hc`: 
      :type `hc`: HelpControllerBase







   .. method:: GetHelpController(self)

      Returns the help controller associated with this help provider.                  

      :rtype: :ref:`HelpControllerBase`








   .. method:: SetHelpController(self, hc)

      Sets the help controller associated with this help provider.                  


      :param `hc`: 
      :type `hc`: HelpControllerBase







   .. attribute:: HelpController

      See :meth:`~HelpControllerHelpProvider.GetHelpController` and :meth:`~HelpControllerHelpProvider.SetHelpController`