File: wx.PopupWindow.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (187 lines) | stat: -rw-r--r-- 4,716 bytes parent folder | download
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
.. 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.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

   <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>PopupWindow</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.PopupWindow_inheritance.png" alt="Inheritance diagram of PopupWindow" 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="39,315,168,344"/> <area shape="rect" id="node2" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="25,237,183,267"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node4" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> <area shape="rect" id="node6" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> </map> 
   </p>

|


|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