************
wx.TipWindow
************

Inheritance diagram for `wx.TipWindow`:

|

.. inheritance-diagram:: wx.TipWindow

|

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

Shows simple text in a popup tip window on creation. This is used by `wx.SimpleHelpProvider <wx.SimpleHelpProvider.html>`_ 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.


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

* `wx.PopupTransientWindow <wx.PopupTransientWindow.html>`_
* `wx.PopupWindow <wx.PopupWindow.html>`_
* `wx.Window <wx.Window.html>`_ 
* `wx.EvtHandler <wx.EvtHandler.html>`_ 
* `wx.Object <wx.Object.html>`_ 


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

* `__init__ <#__init__>`_ 
* `SetBoundingRect <#SetBoundingRect>`_ 

Class API
=========

Methods
^^^^^^^


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

   Constructor. The tip is shown immediately after the window is constructed.

   **Parameters:**

   * `parent` (`wx.Window <wx.Window.html>`_)
   * `text` (string)
   * `maxLength` (int)
   * `rectBound` (`wx.Rect <wx.Rect.html>`_)

   |

   **Returns:**

   `wx.TipWindow <wx.TipWindow.html>`_
 

--------

.. method:: SetBoundingRect(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.

   **Parameters:**

   * `rectBound` (`wx.Rect <wx.Rect.html>`_): The bounding rectangle for the mouse in the screen coordinates