.. include:: headings.inc



.. _TipWindow:

==========================================================================================================================================
|phoenix_title|  **TipWindow**
==========================================================================================================================================

Shows simple text in a popup tip window on creation.          

This is used by :ref:`SimpleHelpProvider`  to show popup help. The window automatically destroys itself when the user clicks on it or it loses the focus. 

You may also use this class to emulate the tooltips when you need finer control over them than what the standard tooltips provide. 









|

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

Inheritance diagram for class **TipWindow**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/TipWindow_inheritance.png" alt="Inheritance diagram of TipWindow" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" 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="node3" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="148,31,247,62"/> <area shape="rect" id="node2" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,58,99,89"/> <area shape="rect" id="node6" 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="node8" href="TipWindow.html" title="Shows simple text in a popup tip window on creation." alt="" coords="428,31,529,62"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~TipWindow.__init__`                                                      Constructor.
:meth:`~TipWindow.SetBoundingRect`                                               By default, the tip window disappears when the user clicks the mouse or presses a keyboard key or if it loses focus in any other way - for example because the user switched to another application window.
================================================================================ ================================================================================


|


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

.. class:: TipWindow(Window)

   Shows simple text in a popup tip window on creation.
   
   **Possible constructors**::

       TipWindow(parent, text, maxLength=100)
       



   .. method:: __init__(self, parent, text, maxLength=100)

      Constructor.                  

      The tip is shown immediately after the window is constructed. 




      :param `parent`: The parent window, must be not ``None``   
      :type `parent`: Window
      :param `text`: The text to show, may contain the new line characters   
      :type `text`: string
      :param `maxLength`: The length of each line, in pixels. Set to a very large value to avoid wrapping lines   
      :type `maxLength`: int










      Simply passed to :meth:`SetTipWindowPtr`   below, please see its documentation for the description of this parameter  



      If not ``None``, passed to :meth:`SetBoundingRect`   below, please see its documentation for the description of this parameter  

                  





   .. method:: SetBoundingRect(self, rectBound)

      By default, the tip window disappears when the user clicks the mouse or presses a keyboard key or if it loses focus in any other way - for example because the user switched to another application window.                  

      Additionally, if a non-empty `rectBound`  is provided, the tip window will also automatically close if the mouse leaves this area. This is useful to dismiss the tip mouse when the mouse leaves the object it is associated with. 




      :param `rectBound`: The bounding rectangle for the mouse in the screen coordinates   
      :type `rectBound`: Rect