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
|
.. 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.adv.SashLayoutWindow:
==========================================================================================================================================
|phoenix_title| **wx.adv.SashLayoutWindow**
==========================================================================================================================================
:ref:`wx.adv.SashLayoutWindow` responds to OnCalculateLayout events generated by :ref:`wx.adv.LayoutAlgorithm`.
It allows the application to use simple accessors to specify how the window should be laid out, rather than having to respond to events.
The fact that the class derives from :ref:`wx.adv.SashWindow` allows sashes to be used if required, to allow the windows to be user-resizable.
The documentation for :ref:`wx.adv.LayoutAlgorithm` explains the purpose of this class in more detail.
For the window styles see :ref:`wx.adv.SashWindow`.
This class handles the ``EVT_QUERY_LAYOUT_INFO`` and ``EVT_CALCULATE_LAYOUT`` events for you. However, if you use sashes, see :ref:`wx.adv.SashWindow` for relevant event information. See also :ref:`wx.adv.LayoutAlgorithm` for information about the layout events.
.. seealso:: :ref:`wx.adv.LayoutAlgorithm`, :ref:`wx.adv.SashWindow`, :ref:`Events and Event Handling <events and event handling>`
|
|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>SashLayoutWindow</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.adv.SashLayoutWindow_inheritance.png" alt="Inheritance diagram of SashLayoutWindow" 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.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node4" href="wx.adv.SashWindow.html" title="wx.adv.SashWindow" alt="" coords="31,237,177,267"/> <area shape="rect" id="node6" href="wx.adv.SashLayoutWindow.html" title="wx.adv.SashLayoutWindow" alt="" coords="9,315,199,344"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.adv.SashLayoutWindow.__init__` Default constructor.
:meth:`~wx.adv.SashLayoutWindow.Create` Initializes a sash layout window, which can be a child of a frame, dialog or any other non-control window.
:meth:`~wx.adv.SashLayoutWindow.GetAlignment` Returns the alignment of the window: one of ``wx.adv.LAYOUT_TOP``, ``wx.adv.LAYOUT_LEFT``, ``wx.adv.LAYOUT_RIGHT``, ``wx.adv.LAYOUT_BOTTOM``.
:meth:`~wx.adv.SashLayoutWindow.GetOrientation` Returns the orientation of the window: one of ``wx.adv.LAYOUT_HORIZONTAL``, ``wx.adv.LAYOUT_VERTICAL``.
:meth:`~wx.adv.SashLayoutWindow.OnCalculateLayout` The default handler for the event that is generated by :ref:`wx.adv.LayoutAlgorithm`.
:meth:`~wx.adv.SashLayoutWindow.OnQueryLayoutInfo` The default handler for the event that is generated by OnCalculateLayout to get size, alignment and orientation information for the window.
:meth:`~wx.adv.SashLayoutWindow.SetAlignment` Sets the alignment of the window (which edge of the available parent client area the window is attached to).
:meth:`~wx.adv.SashLayoutWindow.SetDefaultSize` Sets the default dimensions of the window.
:meth:`~wx.adv.SashLayoutWindow.SetOrientation` Sets the orientation of the window (the direction the window will stretch in, to fill the available parent client area).
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.adv.SashLayoutWindow.Alignment` See :meth:`~wx.adv.SashLayoutWindow.GetAlignment` and :meth:`~wx.adv.SashLayoutWindow.SetAlignment`
:attr:`~wx.adv.SashLayoutWindow.Orientation` See :meth:`~wx.adv.SashLayoutWindow.GetOrientation` and :meth:`~wx.adv.SashLayoutWindow.SetOrientation`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.adv.SashLayoutWindow(SashWindow)
**Possible constructors**::
SashLayoutWindow()
SashLayoutWindow(parent, id=ID_ANY, pos=DefaultPosition,
size=DefaultSize, style=CLIP_CHILDREN|SW_3D, name="layoutWindow")
SashLayoutWindow responds to OnCalculateLayout events generated by
LayoutAlgorithm.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=CLIP_CHILDREN|SW_3D, name="layoutWindow")`
Constructs a sash layout window, which can be a child of a frame, dialog or any other non-control window.
:param `parent`: Pointer to a parent window.
:type `parent`: wx.Window
:param `id`: Window identifier. If -1, will automatically create an identifier.
:type `id`: wx.WindowID
:param `pos`: Window position. DefaultPosition is (-1, -1) which indicates that SashLayoutWindows should generate a default position for the window. If using the :ref:`wx.adv.SashLayoutWindow` class directly, supply an actual position.
:type `pos`: wx.Point
:param `size`: Window size. DefaultSize is (-1, -1) which indicates that SashLayoutWindows should generate a default size for the window.
:type `size`: wx.Size
:param `style`: Window style. For window styles, please see :ref:`wx.adv.SashLayoutWindow`.
:type `style`: long
:param `name`: Window name.
:type `name`: string
**~~~**
.. method:: Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=CLIP_CHILDREN|SW_3D, name="layoutWindow")
Initializes a sash layout window, which can be a child of a frame, dialog or any other non-control window.
:param `parent`: Pointer to a parent window.
:type `parent`: wx.Window
:param `id`: Window identifier. If -1, will automatically create an identifier.
:type `id`: wx.WindowID
:param `pos`: Window position. DefaultPosition is (-1, -1) which indicates that SashLayoutWindows should generate a default position for the window. If using the :ref:`wx.adv.SashLayoutWindow` class directly, supply an actual position.
:type `pos`: wx.Point
:param `size`: Window size. DefaultSize is (-1, -1) which indicates that SashLayoutWindows should generate a default size for the window.
:type `size`: wx.Size
:param `style`: Window style. For window styles, please see :ref:`wx.adv.SashLayoutWindow`.
:type `style`: long
:param `name`: Window name.
:type `name`: string
:rtype: `bool`
.. method:: GetAlignment(self)
Returns the alignment of the window: one of ``wx.adv.LAYOUT_TOP``, ``wx.adv.LAYOUT_LEFT``, ``wx.adv.LAYOUT_RIGHT``, ``wx.adv.LAYOUT_BOTTOM``.
:rtype: :ref:`wx.adv.LayoutAlignment`
.. method:: GetOrientation(self)
Returns the orientation of the window: one of ``wx.adv.LAYOUT_HORIZONTAL``, ``wx.adv.LAYOUT_VERTICAL``.
:rtype: :ref:`wx.adv.LayoutOrientation`
.. method:: OnCalculateLayout(self, event)
The default handler for the event that is generated by :ref:`wx.adv.LayoutAlgorithm`.
The implementation of this function calls :meth:`wx.adv.CalculateLayoutEvent.SetRect` to shrink the provided size according to how much space this window takes up. For further details, see :ref:`wx.adv.LayoutAlgorithm` and :ref:`wx.adv.CalculateLayoutEvent`.
:param `event`:
:type `event`: wx.adv.CalculateLayoutEvent
.. method:: OnQueryLayoutInfo(self, event)
The default handler for the event that is generated by OnCalculateLayout to get size, alignment and orientation information for the window.
The implementation of this function uses member variables as set by accessors called by the application.
For further details, see :ref:`wx.adv.LayoutAlgorithm` and :ref:`wx.adv.QueryLayoutInfoEvent`.
:param `event`:
:type `event`: wx.adv.QueryLayoutInfoEvent
.. method:: SetAlignment(self, alignment)
Sets the alignment of the window (which edge of the available parent client area the window is attached to).
`alignment` is one of ``wx.adv.LAYOUT_TOP``, ``wx.adv.LAYOUT_LEFT``, ``wx.adv.LAYOUT_RIGHT``, ``wx.adv.LAYOUT_BOTTOM``.
:param `alignment`:
:type `alignment`: wx.adv.LayoutAlignment
.. method:: SetDefaultSize(self, size)
Sets the default dimensions of the window.
The dimension other than the orientation will be fixed to this value, and the orientation dimension will be ignored and the window stretched to fit the available space.
:param `size`:
:type `size`: wx.Size
.. method:: SetOrientation(self, orientation)
Sets the orientation of the window (the direction the window will stretch in, to fill the available parent client area).
`orientation` is one of ``wx.adv.LAYOUT_HORIZONTAL``, ``wx.adv.LAYOUT_VERTICAL``.
:param `orientation`:
:type `orientation`: wx.adv.LayoutOrientation
.. attribute:: Alignment
See :meth:`~wx.adv.SashLayoutWindow.GetAlignment` and :meth:`~wx.adv.SashLayoutWindow.SetAlignment`
.. attribute:: Orientation
See :meth:`~wx.adv.SashLayoutWindow.GetOrientation` and :meth:`~wx.adv.SashLayoutWindow.SetOrientation`
|
