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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.ogl.basic
.. highlight:: python
.. _wx.lib.ogl.basic.ShapeRegion:
==========================================================================================================================================
|phoenix_title| **wx.lib.ogl.basic.ShapeRegion**
==========================================================================================================================================
The :class:`ShapeRegion` class.
|
|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>ShapeRegion</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.basic.ShapeRegion_inheritance.png" alt="Inheritance diagram of ShapeRegion" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.ogl.basic.ShapeRegion.html" title="wx.lib.ogl.basic.ShapeRegion" alt="" coords="5,5,216,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.ogl.basic.ShapeRegion.__init__` Default class constructor
:meth:`~wx.lib.ogl.basic.ShapeRegion.ClearText` Clear the text.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetActualColourObject` Get the actual colour object from the :class:`wx.ColourDatabase`.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetActualPen` Get actual pen.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetColour` Get the colour.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetFont` Get the font.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetFormatMode` Get the format mode.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetFormattedText` Get the formatted text.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetHeight` Get the height.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetMinSize` Get the minimum size.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetName` Get the name.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetPenColour` Get the pen colour
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetPenStyle` Get the pen style.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetPosition` Get the position.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetProportion` Get the proportion.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetSize` Get the size.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetText` Get the text.
:meth:`~wx.lib.ogl.basic.ShapeRegion.GetWidth` Get the width.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetColour` Set the colour.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetFont` Set the font.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetFormatMode` Set the format mode of the region.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetMinSize` Set the minimum size.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetName` Set the name.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetPenColour` Set the pen colour.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetPenStyle` Set the pen style.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetPosition` Set the position.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetProportions` Set the proportions.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetSize` Set the size.
:meth:`~wx.lib.ogl.basic.ShapeRegion.SetText` Set the text.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ShapeRegion(object)
The :class:`ShapeRegion` class.
.. method:: __init__(self, region = None)
Default class constructor
:param `region`: a parent region or None???
.. method:: ClearText(self)
Clear the text.
.. method:: GetActualColourObject(self)
Get the actual colour object from the :class:`wx.ColourDatabase`.
.. method:: GetActualPen(self)
Get actual pen.
:note: Returns NULL if the pen is invisible
(different to pen being transparent; indicates that
region boundary should not be drawn.)
.. method:: GetColour(self)
Get the colour.
.. method:: GetFont(self)
Get the font.
.. method:: GetFormatMode(self)
Get the format mode.
.. method:: GetFormattedText(self)
Get the formatted text.
.. method:: GetHeight(self)
Get the height.
.. method:: GetMinSize(self)
Get the minimum size.
.. method:: GetName(self)
Get the name.
.. method:: GetPenColour(self)
Get the pen colour
.. method:: GetPenStyle(self)
Get the pen style.
.. method:: GetPosition(self)
Get the position.
.. method:: GetProportion(self)
Get the proportion.
.. method:: GetSize(self)
Get the size.
.. method:: GetText(self)
Get the text.
.. method:: GetWidth(self)
Get the width.
.. method:: SetColour(self, col)
Set the colour.
:param str `col`: a valid colour name,
see :class:`wx.ColourDatabase`
.. method:: SetFont(self, f)
Set the font.
:param `f`: an instance of :class:`wx.Font`
.. method:: SetFormatMode(self, mode)
Set the format mode of the region.
:param `mode`: can be a bit list of the following
============================== ==============================
Format mode Description
============================== ==============================
`FORMAT_NONE` No formatting
`FORMAT_CENTRE_HORIZ` Horizontal centring
`FORMAT_CENTRE_VERT` Vertical centring
============================== ==============================
.. method:: SetMinSize(self, w, h)
Set the minimum size.
:param `w`: the minimum width
:Param `h`: the minimum height
.. method:: SetName(self, s)
Set the name.
:param str `s`: the name
.. method:: SetPenColour(self, col)
Set the pen colour.
:param str `col`: a valid colour name,
see :class:`wx.ColourDatabase`
.. method:: SetPenStyle(self, style)
Set the pen style.
:param `style`: the style, see :class:`wx.Pen`
.. method:: SetPosition(self, xp, yp)
Set the position.
:param `xp`: the x position
:Param `yp`: the y position
.. method:: SetProportions(self, xp, yp)
Set the proportions.
:param `xp`: the x region proportion
:Param `yp`: the y region proportion
.. method:: SetSize(self, w, h)
Set the size.
:param `w`: the width
:Param `h`: the jeight
.. method:: SetText(self, s)
Set the text.
:param str `s`: the text
|
