.. include:: headings.inc



.. _PopupWindow:

==========================================================================================================================================
|phoenix_title|  **PopupWindow**
==========================================================================================================================================

A special kind of top level window used for popup menus, combobox popups and such.          







         



.. seealso:: :ref:`Dialog`, :ref:`Frame`    







|

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

Inheritance diagram for class **PopupWindow**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/PopupWindow_inheritance.png" alt="Inheritance diagram of PopupWindow" 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="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="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="16,5,88,35"/> <area shape="rect" id="node6" 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="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,58,99,89"/> <area shape="rect" id="node9" 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>

|


|sub_classes| Known Subclasses
==============================

:ref:`PopupTransientWindow`

|


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

================================================================================ ================================================================================
:meth:`~PopupWindow.__init__`                                                    Default constructor.
:meth:`~PopupWindow.Create`                                                      Create method for two-step creation.
:meth:`~PopupWindow.Position`                                                    Move the popup window to the right position, i.e.
================================================================================ ================================================================================


|


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

.. class:: PopupWindow(NonOwnedWindow)

   A special kind of top level window used for popup menus, combobox popups and such.
   
   **Possible constructors**::

       PopupWindow()
       
       PopupWindow(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:: Create(self, parent, flags=BORDER_NONE)

      Create method for two-step creation.                  


      :param `parent`: 
      :type `parent`: Window
      :param `flags`: 
      :type `flags`: int




      :rtype: `bool`








   .. method:: Position(self, ptOrigin, sizePopup)

      Move the popup window to the right position, i.e.                  

      such that it is entirely visible. 

      The popup is positioned at ptOrigin + size if it opens below and to the right (default), at ptOrigin - sizePopup if it opens above and to the left etc. 




      :param `ptOrigin`: Must be given in screen coordinates!   
      :type `ptOrigin`: Point
      :param `sizePopup`: The size of the popup window   
      :type `sizePopup`: Size