.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2017 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.PopupWindow:
==========================================================================================================================================
|phoenix_title| **wx.PopupWindow**
==========================================================================================================================================
A special kind of top level window used for popup menus, combobox popups and such.
.. seealso:: :ref:`wx.Dialog`, :ref:`wx.Frame`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
Inheritance diagram for class
PopupWindow:
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.PopupTransientWindow`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PopupWindow.__init__` Default constructor.
:meth:`~wx.PopupWindow.Create` Create method for two-step creation.
:meth:`~wx.PopupWindow.Position` Move the popup window to the right position, i.e. such that it is entirely visible.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PopupWindow(NonOwnedWindow)
**Possible constructors**::
PopupWindow()
PopupWindow(parent, flags=BORDER_NONE)
A special kind of top level window used for popup menus, combobox
popups and such.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, parent, flags=BORDER_NONE)`
Constructor.
:param `parent`:
:type `parent`: wx.Window
:param `flags`:
:type `flags`: int
**~~~**
.. method:: Create(self, parent, flags=BORDER_NONE)
Create method for two-step creation.
:param `parent`:
:type `parent`: wx.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`: wx.Point
:param `sizePopup`: The size of the popup window
:type `sizePopup`: wx.Size