.. include:: headings.inc



.. _PopupTransientWindow:

==========================================================================================================================================
|phoenix_title|  **PopupTransientWindow**
==========================================================================================================================================

A :ref:`PopupWindow`  which disappears automatically when the user clicks mouse outside it or if it loses focus in any other way.          

This window can be useful for implementing custom combobox-like controls for example. 







         



.. seealso:: :ref:`PopupWindow`    







|

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

Inheritance diagram for class **PopupTransientWindow**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/PopupTransientWindow_inheritance.png" alt="Inheritance diagram of PopupTransientWindow" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="PopupWindow.html" title="A special kind of top level window used for popup menus, combobox popups and such." alt="" coords="635,31,763,62"/> <area shape="rect" id="node11" href="PopupTransientWindow.html" title="A PopupWindow  which disappears automatically when the user clicks mouse outside it or if it loses focus in any other way." alt="" coords="811,31,1005,62"/> <area shape="rect" id="node2" href="NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="427,31,587,62"/> <area shape="rect" id="node4" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,5,99,35"/> <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="node5" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="16,58,88,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"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~PopupTransientWindow.__init__`                                           Default constructor.
:meth:`~PopupTransientWindow.Dismiss`                                            Hide the window.
:meth:`~PopupTransientWindow.OnDismiss`                                          This is called when the popup is disappeared because of anything else but direct call to :meth:`Dismiss` .
:meth:`~PopupTransientWindow.Popup`                                              Popup the window (this will show it too).
:meth:`~PopupTransientWindow.ProcessLeftDown`                                    Called when a mouse is pressed while the popup is shown.
================================================================================ ================================================================================


|


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

.. class:: PopupTransientWindow(PopupWindow)

   A PopupWindow which disappears automatically when the user clicks mouse outside it or if it loses focus in any other way.
   
   **Possible constructors**::

       PopupTransientWindow()
       
       PopupTransientWindow(parent, flags=BORDER_NONE)
       



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self)`
      
      Default constructor.                   
      
      
      
      
      **~~~**

      
      **__init__** `(self, parent, flags=BORDER_NONE)`
      
      Constructor.                  
      
      
      :param `parent`: 
      :type `parent`: Window
      :param `flags`: 
      :type `flags`: int
      
      
      
      
      
      
      **~~~**






   .. method:: Dismiss(self)

      Hide the window.                   





   .. method:: OnDismiss(self)

      This is called when the popup is disappeared because of anything else but direct call to :meth:`Dismiss` .                   





   .. method:: Popup(self, focus=None)

      Popup the window (this will show it too).                  

      If `winFocus`  is not ``None``, it will be kept focused while this window is shown, otherwise this window itself will receive focus. In any case, the popup will disappear automatically if it loses focus because of a user action. 

                


      :param `focus`: 
      :type `focus`: Window






      .. seealso:: :meth:`Dismiss`     








   .. method:: ProcessLeftDown(self, event)

      Called when a mouse is pressed while the popup is shown.                  

      Return ``True`` from here to prevent its normal processing by the popup (which consists in dismissing it if the mouse is clicked outside it).                  


      :param `event`: 
      :type `event`: MouseEvent




      :rtype: `bool`