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
|
.. 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.ProgressPie:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.piectrl.ProgressPie**
==========================================================================================================================================
:class:`ProgressPie` tries to emulate the behavior of :class:`ProgressDialog`, but
using a pie chart instead of a gauge.
|
|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>ProgressPie</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.ProgressPie_inheritance.png" alt="Inheritance diagram of ProgressPie" 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="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node2" href="wx.lib.agw.piectrl.ProgressPie.html" title="wx.lib.agw.piectrl.ProgressPie" alt="" coords="10,392,216,421"/> <area shape="rect" id="node3" href="wx.lib.agw.piectrl.PieCtrl.html" title="wx.lib.agw.piectrl.PieCtrl" alt="" coords="27,315,199,344"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="53,160,173,189"/> <area shape="rect" id="node7" href="wx.Window.html" title="wx.Window" alt="" coords="69,237,157,267"/> <area shape="rect" id="node6" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.lib.agw.piectrl.progresspie.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.progresspie.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.piectrl.PieCtrl`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.piectrl.ProgressPie.__init__` Default class constructor.
:meth:`~wx.lib.agw.piectrl.ProgressPie.GetFilledColour` Returns the colour that progressively fills the :class:`ProgressPie`.
:meth:`~wx.lib.agw.piectrl.ProgressPie.GetMaxValue` Returns the :class:`ProgressPie` maximum value.
:meth:`~wx.lib.agw.piectrl.ProgressPie.GetUnfilledColour` Returns the colour that is filled.
:meth:`~wx.lib.agw.piectrl.ProgressPie.GetValue` Returns the :class:`ProgressPie` value.
:meth:`~wx.lib.agw.piectrl.ProgressPie.SetFilledColour` Sets the colour that progressively fills the :class:`ProgressPie` .
:meth:`~wx.lib.agw.piectrl.ProgressPie.SetMaxValue` Sets the :class:`ProgressPie` maximum value.
:meth:`~wx.lib.agw.piectrl.ProgressPie.SetUnfilledColour` Sets the colour that is filled.
:meth:`~wx.lib.agw.piectrl.ProgressPie.SetValue` Sets the :class:`ProgressPie` value.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ProgressPie(PieCtrl)
:class:`ProgressPie` tries to emulate the behavior of :class:`ProgressDialog`, but
using a pie chart instead of a gauge.
.. method:: __init__(self, parent, maxvalue, value, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0)
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:: GetFilledColour(self)
Returns the colour that progressively fills the :class:`ProgressPie`.
.. method:: GetMaxValue(self)
Returns the :class:`ProgressPie` maximum value.
.. method:: GetUnfilledColour(self)
Returns the colour that is filled.
.. method:: GetValue(self)
Returns the :class:`ProgressPie` value.
.. method:: SetFilledColour(self, colour)
Sets the colour that progressively fills the :class:`ProgressPie` .
:param `colour`: a valid :class:`wx.Colour` object.
.. method:: SetMaxValue(self, value)
Sets the :class:`ProgressPie` maximum value.
:param `value`: a floating point number representing the maximum value.
.. method:: SetUnfilledColour(self, colour)
Sets the colour that is filled.
:param `colour`: a valid :class:`wx.Colour` object.
.. method:: SetValue(self, value)
Sets the :class:`ProgressPie` value.
:param `value`: a floating point number representing the new value.
|
