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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
|
.. 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.Panel:
==========================================================================================================================================
|phoenix_title| **wx.Panel**
==========================================================================================================================================
A panel is a window on which controls are placed.
It is usually placed within a frame. Its main feature over its parent class :ref:`wx.Window` is code for handling child windows and ``TAB`` traversal. Since wxWidgets 2.9, there is support both for ``TAB`` traversal implemented by wxWidgets itself as well as native ``TAB`` traversal (such as for GTK 2.0).
.. _Panel-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.NavigationKeyEvent` parameter.
- EVT_NAVIGATION_KEY: Process a navigation key event.
.. note::
By default, a panel has the same colouring as a dialog.
.. note::
Tab traversal is implemented through an otherwise undocumented intermediate ControlContainer class from which any class can derive in addition to the normal :ref:`wx.Window` base class. Please see :ref:`/containr.h` and :ref:`/panel.h` to find out how this is achieved.
.. note::
if not all characters are being intercepted by your OnKeyDown or OnChar handler, it may be because you are using the ``TAB_TRAVERSAL`` style, which grabs some keypresses for use by child controls.
.. seealso:: :ref:`wx.Dialog`
|
|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>Panel</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.Panel_inheritance.png" alt="Inheritance diagram of Panel" 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.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node2" href="wx.Panel.html" title="wx.Panel" alt="" coords="66,237,141,267"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.aui.AuiMDIChildFrame`, :ref:`wx.adv.EditableListBox`, :ref:`wx.HScrolledWindow`, :ref:`wx.HVScrolledWindow`, :ref:`wx.PreviewControlBar`, :ref:`wx.propgrid.PropertyGridManager`, :ref:`wx.RearrangeCtrl`, :ref:`wx.VScrolledWindow`, :ref:`wx.adv.WizardPage`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Panel.__init__` Default constructor.
:meth:`~wx.Panel.AcceptsFocus` This method is overridden from :meth:`wx.Window.AcceptsFocus` and returns ``True`` only if there is no child window in the panel which can accept the focus.
:meth:`~wx.Panel.Create` Used for two-step panel construction.
:meth:`~wx.Panel.InitDialog` Sends a :ref:`wx.InitDialogEvent`, which in turn transfers data to the dialog via validators.
:meth:`~wx.Panel.Layout` See :meth:`wx.Window.SetAutoLayout` : when auto layout is on, this function gets called automatically when the window is resized.
:meth:`~wx.Panel.SetFocus` Overrides :meth:`wx.Window.SetFocus` .
:meth:`~wx.Panel.SetFocusIgnoringChildren` In contrast to :meth:`~Panel.SetFocus` (see above) this will set the focus to the panel even if there are child windows in the panel.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Panel(Window)
**Possible constructors**::
Panel()
Panel(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
style=TAB_TRAVERSAL, name=PanelNameStr)
A panel is a window on which controls are placed.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TAB_TRAVERSAL, name=PanelNameStr)`
Constructor.
:param `parent`: The parent window.
:type `parent`: wx.Window
:param `id`: An identifier for the panel. ``ID_ANY`` is taken to mean a default.
:type `id`: wx.WindowID
:param `pos`: The panel position. The value :ref:`wx.DefaultPosition` indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.
:type `pos`: wx.Point
:param `size`: The panel size. The value :ref:`wx.DefaultSize` indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
:type `size`: wx.Size
:param `style`: The window style. See :ref:`wx.Panel`.
:type `style`: long
:param `name`: Window name.
:type `name`: string
.. seealso:: :meth:`Create`
**~~~**
.. method:: AcceptsFocus(self)
This method is overridden from :meth:`wx.Window.AcceptsFocus` and returns ``True`` only if there is no child window in the panel which can accept the focus.
This is reevaluated each time a child window is added or removed from the panel.
:rtype: `bool`
.. method:: Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=TAB_TRAVERSAL, name=PanelNameStr)
Used for two-step panel construction.
See :ref:`wx.Panel` for details.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
:rtype: `bool`
.. method:: InitDialog(self)
Sends a :ref:`wx.InitDialogEvent`, which in turn transfers data to the dialog via validators.
.. seealso:: :ref:`wx.InitDialogEvent`
.. method:: Layout(self)
See :meth:`wx.Window.SetAutoLayout` : when auto layout is on, this function gets called automatically when the window is resized.
:rtype: `bool`
.. method:: SetFocus(self)
Overrides :meth:`wx.Window.SetFocus` .
This method uses the (undocumented) mix-in class ControlContainer which manages the focus and ``TAB`` logic for controls which usually have child controls.
In practice, if you call this method and the control has at least one child window, the focus will be given to the child window.
.. seealso:: :ref:`wx.FocusEvent`, :meth:`wx.Window.SetFocus`
.. method:: SetFocusIgnoringChildren(self)
In contrast to :meth:`SetFocus` (see above) this will set the focus to the panel even if there are child windows in the panel.
This is only rarely needed.
|
