1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 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
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>PopupTransientWindow</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.PopupTransientWindow_inheritance.png" alt="Inheritance diagram of PopupTransientWindow" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.PopupWindow.html" title="wx.PopupWindow" alt="" coords="49,315,177,344"/> <area shape="rect" id="node7" href="wx.PopupTransientWindow.html" title="wx.PopupTransientWindow" alt="" coords="20,392,207,421"/> <area shape="rect" id="node2" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="34,237,192,267"/> <area shape="rect" id="node3" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="5,5,107,35"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="69,160,157,189"/> </map>
</p>
|
|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 non-NULL, 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`
|