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
|
.. 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.agw.piectrl
.. highlight:: python
.. _wx.lib.agw.piectrl.PieCtrl:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.piectrl.PieCtrl**
==========================================================================================================================================
:class:`PieCtrl` is somewhat a "static" control, that you may create in order to display
a simple pie chart on a :class:`Panel` or similar.
|
|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>PieCtrl</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.agw.piectrl.PieCtrl_inheritance.png" alt="Inheritance diagram of PieCtrl" 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.Trackable.html" title="wx.Trackable" alt="" coords="5,5,107,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="53,160,173,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="69,237,157,267"/> <area shape="rect" id="node6" href="wx.lib.agw.piectrl.PieCtrl.html" title="wx.lib.agw.piectrl.PieCtrl" alt="" coords="27,315,199,344"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.lib.agw.piectrl.piectrl.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/../no_appearance.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.lib.agw.piectrl.piectrl.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.piectrl.ProgressPie`
|
|super_classes| Known Superclasses
==================================
:class:`wx.Window`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.piectrl.PieCtrl.__init__` Default class constructor.
:meth:`~wx.lib.agw.piectrl.PieCtrl.Draw` Draws all the sectors of :class:`PieCtrl`.
:meth:`~wx.lib.agw.piectrl.PieCtrl.DrawParts` Draws the :class:`PieCtrl` external edges.
:meth:`~wx.lib.agw.piectrl.PieCtrl.GetAngle` Returns the orientation angle for :class:`PieCtrl`, in radians.
:meth:`~wx.lib.agw.piectrl.PieCtrl.GetBackColour` Returns the :class:`PieCtrl` background colour.
:meth:`~wx.lib.agw.piectrl.PieCtrl.GetBackground` Returns the :class:`PieCtrl` background image.
:meth:`~wx.lib.agw.piectrl.PieCtrl.GetHeight` Returns the height (in pixels) of the :class:`PieCtrl`.
:meth:`~wx.lib.agw.piectrl.PieCtrl.GetLegend` Returns the :class:`PieCtrl` legend.
:meth:`~wx.lib.agw.piectrl.PieCtrl.GetPartAngles` Returns the angles associated to all segments.
:meth:`~wx.lib.agw.piectrl.PieCtrl.GetRotationAngle` Returns the angle at which the first sector starts, in radians.
:meth:`~wx.lib.agw.piectrl.PieCtrl.GetShowEdges` Returns whether the :class:`PieCtrl` edges are visible or not.
:meth:`~wx.lib.agw.piectrl.PieCtrl.OnPaint` Handles the ``wx.EVT_PAINT`` event for :class:`PieCtrl`.
:meth:`~wx.lib.agw.piectrl.PieCtrl.OnSize` Handles the ``wx.EVT_SIZE`` event for :class:`PieCtrl`.
:meth:`~wx.lib.agw.piectrl.PieCtrl.RecreateCanvas` Recreates the :class:`PieCtrl` container (canvas).
:meth:`~wx.lib.agw.piectrl.PieCtrl.SetAngle` Sets the orientation angle for :class:`PieCtrl`.
:meth:`~wx.lib.agw.piectrl.PieCtrl.SetBackColour` Sets the :class:`PieCtrl` background colour.
:meth:`~wx.lib.agw.piectrl.PieCtrl.SetBackground` Sets the :class:`PieCtrl` background image.
:meth:`~wx.lib.agw.piectrl.PieCtrl.SetHeight` Sets the height (in pixels) of the :class:`PieCtrl`.
:meth:`~wx.lib.agw.piectrl.PieCtrl.SetRotationAngle` Sets the angle at which the first sector starts.
:meth:`~wx.lib.agw.piectrl.PieCtrl.SetShowEdges` Sets whether the :class:`PieCtrl` edges are visible or not.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: PieCtrl(wx.Window)
:class:`PieCtrl` is somewhat a "static" control, that you may create in order to display
a simple pie chart on a :class:`Panel` or similar.
.. method:: __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name="PieCtrl")
Default class constructor.
:param `parent`: the :class:`PieCtrl` parent. Must not be ``None``;
:param `id`: window identifier. A value of -1 indicates a default value;
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
:param `style`: the window style (unused);
:param `name`: the window name.
.. method:: Draw(self, pdc)
Draws all the sectors of :class:`PieCtrl`.
:param `dc`: an instance of :class:`wx.DC`.
.. method:: DrawParts(self, dc, cx, cy, w, h)
Draws the :class:`PieCtrl` external edges.
:param `dc`: an instance of :class:`wx.DC`;
:param `cx`: the part `x` coordinate;
:param `cy`: the part `y` coordinate;
:param `w`: the control's width;
:param `h`: the control's height.
.. method:: GetAngle(self)
Returns the orientation angle for :class:`PieCtrl`, in radians.
.. method:: GetBackColour(self)
Returns the :class:`PieCtrl` background colour.
.. method:: GetBackground(self)
Returns the :class:`PieCtrl` background image.
.. method:: GetHeight(self)
Returns the height (in pixels) of the :class:`PieCtrl`.
.. method:: GetLegend(self)
Returns the :class:`PieCtrl` legend.
.. method:: GetPartAngles(self)
Returns the angles associated to all segments.
.. method:: GetRotationAngle(self)
Returns the angle at which the first sector starts, in radians.
.. method:: GetShowEdges(self)
Returns whether the :class:`PieCtrl` edges are visible or not.
.. method:: OnPaint(self, event)
Handles the ``wx.EVT_PAINT`` event for :class:`PieCtrl`.
:param `event`: a :class:`PaintEvent` event to be processed.
.. method:: OnSize(self, event)
Handles the ``wx.EVT_SIZE`` event for :class:`PieCtrl`.
:param `event`: a :class:`wx.SizeEvent` event to be processed.
.. method:: RecreateCanvas(self)
Recreates the :class:`PieCtrl` container (canvas).
.. method:: SetAngle(self, angle)
Sets the orientation angle for :class:`PieCtrl`.
:param `angle`: the orientation angle for :class:`PieCtrl`, in radians.
.. method:: SetBackColour(self, colour)
Sets the :class:`PieCtrl` background colour.
:param `colour`: a valid :class:`wx.Colour` object.
.. method:: SetBackground(self, bmp)
Sets the :class:`PieCtrl` background image.
:param `bmp`: a valid :class:`wx.Bitmap` object.
.. method:: SetHeight(self, value)
Sets the height (in pixels) of the :class:`PieCtrl`.
:param `value`: the new height of the widget, in pixels.
.. method:: SetRotationAngle(self, angle)
Sets the angle at which the first sector starts.
:param `angle`: the first sector angle, in radians.
.. method:: SetShowEdges(self, value=True)
Sets whether the :class:`PieCtrl` edges are visible or not.
:param `value`: ``True`` to show the edges, ``False`` to hide them.
|
