.. 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.PopupTransientWindow:
==========================================================================================================================================
|phoenix_title| **wx.PopupTransientWindow**
==========================================================================================================================================
A :ref:`wx.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:`wx.PopupWindow`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
Inheritance diagram for class
PopupTransientWindow:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PopupTransientWindow.__init__` Default constructor.
:meth:`~wx.PopupTransientWindow.Dismiss` Hide the window.
:meth:`~wx.PopupTransientWindow.OnDismiss` This is called when the popup is disappeared because of anything else but direct call to :meth:`~PopupTransientWindow.Dismiss` .
:meth:`~wx.PopupTransientWindow.Popup` Popup the window (this will show it too).
:meth:`~wx.PopupTransientWindow.ProcessLeftDown` Called when a mouse is pressed while the popup is shown.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PopupTransientWindow(PopupWindow)
**Possible constructors**::
PopupTransientWindow()
PopupTransientWindow(parent, flags=BORDER_NONE)
A PopupWindow which disappears automatically when the user clicks
mouse outside it or if it loses focus in any other way.
.. 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:: 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`: wx.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`: wx.MouseEvent
:rtype: `bool`