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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
|
.. 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
.. currentmodule:: wx.lib.ogl.composit
.. highlight:: python
.. _wx.lib.ogl.composit.DivisionShape:
==========================================================================================================================================
|phoenix_title| **wx.lib.ogl.composit.DivisionShape**
==========================================================================================================================================
A :class:`DivisionShape` class is a composite with special properties,
to be used for containment. It's a subdivision of a container.
A containing node image consists of a composite with a main child shape
such as rounded rectangle, plus a list of division objects.
It needs to be a composite because a division contains pieces
of diagram.
:note: A container has at least one wxDivisionShape for consistency.
This can be subdivided, so it turns into two objects, then each of
these can be subdivided, etc.
|
|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>DivisionShape</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.lib.ogl.composit.DivisionShape_inheritance.png" alt="Inheritance diagram of DivisionShape" 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.lib.ogl.basic.RectangleShape.html" title="wx.lib.ogl.basic.RectangleShape" alt="" coords="22,160,244,189"/> <area shape="rect" id="node3" href="wx.lib.ogl.composit.CompositeShape.html" title="wx.lib.ogl.composit.CompositeShape" alt="" coords="5,237,261,267"/> <area shape="rect" id="node2" href="wx.lib.ogl.basic.Shape.html" title="wx.lib.ogl.basic.Shape" alt="" coords="53,83,213,112"/> <area shape="rect" id="node4" href="wx.lib.ogl.composit.DivisionShape.html" title="wx.lib.ogl.composit.DivisionShape" alt="" coords="15,315,251,344"/> <area shape="rect" id="node5" href="wx.lib.ogl.basic.ShapeEvtHandler.html" title="wx.lib.ogl.basic.ShapeEvtHandler" alt="" coords="18,5,248,35"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.ogl.composit.CompositeShape`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.ogl.composit.DivisionShape.__init__` Default class constructor.
:meth:`~wx.lib.ogl.composit.DivisionShape.AdjustLeft` Adjust a side.
:meth:`~wx.lib.ogl.composit.DivisionShape.AdjustRight` Adjust a side.
:meth:`~wx.lib.ogl.composit.DivisionShape.AdjustTop` Adjust a side.
:meth:`~wx.lib.ogl.composit.DivisionShape.CalculateSize` not implemented???
:meth:`~wx.lib.ogl.composit.DivisionShape.Divide` Divide this division into two further divisions.
:meth:`~wx.lib.ogl.composit.DivisionShape.EditEdge`
:meth:`~wx.lib.ogl.composit.DivisionShape.GetBottomSide` Return the division on the bottom side of this division.
:meth:`~wx.lib.ogl.composit.DivisionShape.GetHandleSide` Return the side which the handle appears on.
:meth:`~wx.lib.ogl.composit.DivisionShape.GetLeftSide` Return the division on the left side of this division.
:meth:`~wx.lib.ogl.composit.DivisionShape.GetLeftSideColour` Return the colour used for drawing the left side of the division.
:meth:`~wx.lib.ogl.composit.DivisionShape.GetLeftSidePen` Return the pen used for drawing the left side of the division.
:meth:`~wx.lib.ogl.composit.DivisionShape.GetLeftSideStyle` Return the style used for the left side of the division.
:meth:`~wx.lib.ogl.composit.DivisionShape.GetRightSide` Return the division on the right side of this division.
:meth:`~wx.lib.ogl.composit.DivisionShape.GetTopSide` Return the division on the top side of this division.
:meth:`~wx.lib.ogl.composit.DivisionShape.GetTopSideColour` Return the colour used for drawing the top side of the division.
:meth:`~wx.lib.ogl.composit.DivisionShape.GetTopSidePen` Return the pen used for drawing the top side of the division.
:meth:`~wx.lib.ogl.composit.DivisionShape.GetTopSideStyle` Return the style used for the top side of the division.
:meth:`~wx.lib.ogl.composit.DivisionShape.MakeControlPoints` Make control points.
:meth:`~wx.lib.ogl.composit.DivisionShape.MakeMandatoryControlPoints` Make mandatory control points.
:meth:`~wx.lib.ogl.composit.DivisionShape.OnBeginDragLeft` The begin drag left handler.
:meth:`~wx.lib.ogl.composit.DivisionShape.OnDragLeft` The drag left handler.
:meth:`~wx.lib.ogl.composit.DivisionShape.OnDraw` The draw handler.
:meth:`~wx.lib.ogl.composit.DivisionShape.OnDrawContents` The draw contens handler.
:meth:`~wx.lib.ogl.composit.DivisionShape.OnEndDragLeft` The end drag left handler.
:meth:`~wx.lib.ogl.composit.DivisionShape.OnMovePre` The move 'pre' handler.
:meth:`~wx.lib.ogl.composit.DivisionShape.OnRightClick` The right click handler.
:meth:`~wx.lib.ogl.composit.DivisionShape.PopupMenu` Popup menu handler.
:meth:`~wx.lib.ogl.composit.DivisionShape.ResetControlPoints` Reset control points.
:meth:`~wx.lib.ogl.composit.DivisionShape.ResetMandatoryControlPoints` Reset mandatory control points.
:meth:`~wx.lib.ogl.composit.DivisionShape.ResizeAdjoining` Resize adjoining divisions at the given side.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetBottomSide` Set the the division on the bottom side of this division.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetHandleSide` Sets the side which the handle appears on.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetLeftSide` Set the the division on the left side of this division.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetLeftSideColour` Set the colour for drawing the left side of the division.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetLeftSidePen` Set the colour for drawing the left side of the division.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetLeftSideStyle` Set the left side style.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetRightSide` Set the the division on the right side of this division.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetSize` Set the size.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetTopSide` Set the the division on the top side of this division.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetTopSideColour` Set the colour for drawing the top side of the division.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetTopSidePen` Set the colour for drawing the top side of the division.
:meth:`~wx.lib.ogl.composit.DivisionShape.SetTopSideStyle` Set the top side style.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: DivisionShape(CompositeShape)
A :class:`DivisionShape` class is a composite with special properties,
to be used for containment. It's a subdivision of a container.
A containing node image consists of a composite with a main child shape
such as rounded rectangle, plus a list of division objects.
It needs to be a composite because a division contains pieces
of diagram.
:note: A container has at least one wxDivisionShape for consistency.
This can be subdivided, so it turns into two objects, then each of
these can be subdivided, etc.
.. method:: __init__(self)
Default class constructor.
.. method:: AdjustLeft(self, left, test)
Adjust a side.
:param `left`: desired left position ???
:param `test`: if `True` just a test
:returns: `False` if it's not physically possible to adjust it to
this point.
.. method:: AdjustRight(self, right, test)
Adjust a side.
:param `right`: desired right position ???
:param `test`: if `True` just a test
:returns: `False` if it's not physically possible to adjust it to
this point.
.. method:: AdjustTop(self, top, test)
Adjust a side.
:param `top`: desired top position ???
:param `test`: if `True` just a test
:returns: `False` if it's not physically possible to adjust it to
this point.
.. method:: CalculateSize(self)
not implemented???
.. method:: Divide(self, direction)
Divide this division into two further divisions.
:param `direction`: `wx.HORIZONTAL` for horizontal or `wx.VERTICAL` for
vertical division.
.. method:: EditEdge(self, side)
.. method:: GetBottomSide(self)
Return the division on the bottom side of this division.
.. method:: GetHandleSide(self)
Return the side which the handle appears on.
.. method:: GetLeftSide(self)
Return the division on the left side of this division.
.. method:: GetLeftSideColour(self)
Return the colour used for drawing the left side of the division.
.. method:: GetLeftSidePen(self)
Return the pen used for drawing the left side of the division.
.. method:: GetLeftSideStyle(self)
Return the style used for the left side of the division.
.. method:: GetRightSide(self)
Return the division on the right side of this division.
.. method:: GetTopSide(self)
Return the division on the top side of this division.
.. method:: GetTopSideColour(self)
Return the colour used for drawing the top side of the division.
.. method:: GetTopSidePen(self)
Return the pen used for drawing the top side of the division.
.. method:: GetTopSideStyle(self)
Return the style used for the top side of the division.
.. method:: MakeControlPoints(self)
Make control points.
.. method:: MakeMandatoryControlPoints(self)
Make mandatory control points.
.. method:: OnBeginDragLeft(self, x, y, keys = 0, attachment = 0)
The begin drag left handler.
.. method:: OnDragLeft(self, draw, x, y, keys = 0, attachment = 0)
The drag left handler.
.. method:: OnDraw(self, dc)
The draw handler.
.. method:: OnDrawContents(self, dc)
The draw contens handler.
.. method:: OnEndDragLeft(self, x, y, keys = 0, attachment = 0)
The end drag left handler.
.. method:: OnMovePre(self, dc, x, y, oldx, oldy, display = True)
The move 'pre' handler.
.. method:: OnRightClick(self, x, y, keys = 0, attachment = 0)
The right click handler.
.. method:: PopupMenu(self, x, y)
Popup menu handler.
.. method:: ResetControlPoints(self)
Reset control points.
.. method:: ResetMandatoryControlPoints(self)
Reset mandatory control points.
.. method:: ResizeAdjoining(self, side, newPos, test)
Resize adjoining divisions at the given side.
:param `side`: can be one of
======================= =======================
Side option Description
======================= =======================
`DIVISION_SIDE_NONE` no side
`DIVISION_SIDE_LEFT` Left side
`DIVISION_SIDE_TOP` Top side
`DIVISION_SIDE_RIGHT` Right side
`DIVISION_SIDE_BOTTOM` Bottom side
======================= =======================
:param `newPos`: new position
:param `test`: if `True`, just see whether it's possible for each
adjoining region, returning `False` if it's not.
.. method:: SetBottomSide(self, shape)
Set the the division on the bottom side of this division.
.. method:: SetHandleSide(self, side)
Sets the side which the handle appears on.
:param `side`: Either DIVISION_SIDE_LEFT or DIVISION_SIDE_TOP.
.. method:: SetLeftSide(self, shape)
Set the the division on the left side of this division.
.. method:: SetLeftSideColour(self, colour)
Set the colour for drawing the left side of the division.
.. method:: SetLeftSidePen(self, pen)
Set the colour for drawing the left side of the division.
.. method:: SetLeftSideStyle(self, style)
Set the left side style.
:param `style`: valid values ???
.. method:: SetRightSide(self, shape)
Set the the division on the right side of this division.
.. method:: SetSize(self, w, h, recursive = True)
Set the size.
:param `w`: the width
:param `h`: the heigth
:param `recursive`: `True` recurse all children
.. method:: SetTopSide(self, shape)
Set the the division on the top side of this division.
.. method:: SetTopSideColour(self, colour)
Set the colour for drawing the top side of the division.
.. method:: SetTopSidePen(self, pen)
Set the colour for drawing the top side of the division.
.. method:: SetTopSideStyle(self, style)
Set the top side style.
:param `style`: valid values ???
|
