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
|
.. 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.MDIClientWindow:
==========================================================================================================================================
|phoenix_title| **wx.MDIClientWindow**
==========================================================================================================================================
An MDI client window is a child of :ref:`wx.MDIParentFrame`, and manages zero or more :ref:`wx.MDIChildFrame` objects.
The client window is the area where MDI child windows exist. It doesn't have to cover the whole parent frame; other windows such as toolbars and a help window might coexist with it. There can be scrollbars on a client window, which are controlled by the parent window style.
The :ref:`wx.MDIClientWindow` class is usually adequate without further derivation, and it is created automatically when the MDI parent frame is created. If the application needs to derive a new class, the function :meth:`wx.MDIParentFrame.OnCreateClient` must be overridden in order to give an opportunity to use a different class of client window.
Under wxMSW, the client window will automatically have a sunken border style when the active child is not maximized, and no border style when a child is maximized.
.. seealso:: :ref:`wx.MDIChildFrame`, :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>MDIClientWindow</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.MDIClientWindow_inheritance.png" alt="Inheritance diagram of MDIClientWindow" 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="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node2" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> <area shape="rect" id="node4" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node5" href="wx.MDIClientWindow.html" title="wx.MDIClientWindow" alt="" coords="29,237,177,267"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.MDIClientWindow.__init__` Default constructor.
:meth:`~wx.MDIClientWindow.CreateClient` Called by :ref:`wx.MDIParentFrame` immediately after creating the client window.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.MDIClientWindow(Window)
**Possible constructors**::
MDIClientWindow()
An MDI client window is a child of MDIParentFrame, and manages zero
or more MDIChildFrame objects.
.. method:: __init__(self)
Default constructor.
Objects of this class are only created by :ref:`wx.MDIParentFrame` which uses the default constructor and calls :meth:`CreateClient` immediately afterwards.
.. method:: CreateClient(self, parent, style=0)
Called by :ref:`wx.MDIParentFrame` immediately after creating the client window.
This function may be overridden in the derived class but the base class version must usually be called first to really create the window.
:param `parent`: The window parent.
:type `parent`: wx.MDIParentFrame
:param `style`: The window style. Only ``wx.HSCROLL`` and ``wx.VSCROLL`` bits are meaningful here.
:type `style`: long
:rtype: `bool`
|
