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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
|
.. 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.MDIChildFrame:
==========================================================================================================================================
|phoenix_title| **wx.MDIChildFrame**
==========================================================================================================================================
An MDI child frame is a frame that can only exist inside a :ref:`wx.MDIClientWindow`, which is itself a child of :ref:`wx.MDIParentFrame`.
.. _MDIChildFrame-styles:
|styles| Window Styles
================================
This class supports the following styles:
All of the standard :ref:`wx.Frame` styles can be used but most of them are ignored by TDI-based MDI implementations.
.. note::
Although internally an MDI child frame is a child of the MDI client window, in wxWidgets you create it as a child of :ref:`wx.MDIParentFrame`. In fact, you can usually forget that the client window exists. MDI child frames are clipped to the area of the MDI client window, and may be iconized on the client window. You can associate a menubar with a child frame as usual, although an MDI child doesn't display its menubar under its own title bar. The MDI parent frame's menubar will be changed to reflect the currently active child frame. If there are currently no children, the parent frame's own menubar will be displayed.
.. seealso:: :ref:`wx.MDIClientWindow`, :ref:`wx.MDIParentFrame`, :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>MDIChildFrame</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.MDIChildFrame_inheritance.png" alt="Inheritance diagram of MDIChildFrame" 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.Frame.html" title="wx.Frame" alt="" coords="63,392,144,421"/> <area shape="rect" id="node8" href="wx.MDIChildFrame.html" title="wx.MDIChildFrame" alt="" coords="35,469,172,499"/> <area shape="rect" id="node2" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="33,315,175,344"/> <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.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node6" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="25,237,183,267"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`DocMDIChildFrame`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.MDIChildFrame.__init__` Default constructor.
:meth:`~wx.MDIChildFrame.Activate` Activates this MDI child frame.
:meth:`~wx.MDIChildFrame.Create` Used in two-step frame construction.
:meth:`~wx.MDIChildFrame.GetMDIParent` Returns the MDI parent frame containing this child.
:meth:`~wx.MDIChildFrame.IsAlwaysMaximized` Returns ``True`` for MDI children in TDI implementations.
:meth:`~wx.MDIChildFrame.Maximize` Maximizes this MDI child frame.
:meth:`~wx.MDIChildFrame.Restore` Restores this MDI child frame (unmaximizes).
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.MDIChildFrame.MDIParent` See :meth:`~wx.MDIChildFrame.GetMDIParent`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.MDIChildFrame(Frame)
**Possible constructors**::
MDIChildFrame()
MDIChildFrame(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition,
size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr)
An MDI child frame is a frame that can only exist inside a
MDIClientWindow, which is itself a child of MDIParentFrame.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr)`
Constructor, creating the window.
:param `parent`: The window parent. This should not be ``None``.
:type `parent`: wx.MDIParentFrame
:param `id`: The window identifier. It may take a value of -1 to indicate a default value.
:type `id`: wx.WindowID
:param `title`: The caption to be displayed on the frame's title bar.
:type `title`: string
:param `pos`: The window 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 window 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.MDIChildFrame`.
:type `style`: long
:param `name`: The name of the window. This parameter is used to associate a name with the item, allowing the application user to set Motif resource values for individual windows.
:type `name`: string
.. seealso:: :meth:`Create`
**~~~**
.. method:: Activate(self)
Activates this MDI child frame.
.. seealso:: :meth:`Maximize` , :meth:`Restore`
.. method:: Create(self, parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name=FrameNameStr)
Used in two-step frame construction.
See :ref:`wx.MDIChildFrame` for further details.
:param `parent`:
:type `parent`: wx.MDIParentFrame
:param `id`:
:type `id`: wx.WindowID
:param `title`:
:type `title`: string
: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:: GetMDIParent(self)
Returns the MDI parent frame containing this child.
Notice that this may return a different object than :meth:`GetParent` as the child frames may be created as children of the client window internally.
:rtype: :ref:`wx.MDIParentFrame`
.. method:: IsAlwaysMaximized(self)
Returns ``True`` for MDI children in TDI implementations.
TDI-based implementations represent MDI children as pages in a :ref:`wx.Notebook` and so they are always maximized and can't be restored or iconized.
:rtype: `bool`
.. seealso:: :meth:`wx.MDIParentFrame.IsTDI` .
.. method:: Maximize(self, maximize=True)
Maximizes this MDI child frame.
This function doesn't do anything if :meth:`IsAlwaysMaximized` returns ``True``.
:param `maximize`:
:type `maximize`: bool
.. seealso:: :meth:`Activate` , :meth:`Restore`
.. method:: Restore(self)
Restores this MDI child frame (unmaximizes).
This function doesn't do anything if :meth:`IsAlwaysMaximized` returns ``True``.
.. seealso:: :meth:`Activate` , :meth:`Maximize`
.. attribute:: MDIParent
See :meth:`~wx.MDIChildFrame.GetMDIParent`
|
