File: wx.lib.agw.piectrl.PiePart.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (121 lines) | stat: -rw-r--r-- 3,920 bytes parent folder | download
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
.. 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.PiePart:

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.piectrl.PiePart**
==========================================================================================================================================

This class handles the legend segments properties, such as value,
colour and label.



|

|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>PiePart</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.PiePart_inheritance.png" alt="Inheritance diagram of PiePart" 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.agw.piectrl.PiePart.html" title="wx.lib.agw.piectrl.PiePart" alt="" coords="5,5,179,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.agw.piectrl.PiePart.__init__`                                     Default class constructor.
:meth:`~wx.lib.agw.piectrl.PiePart.GetColour`                                    Returns the segment colour.
:meth:`~wx.lib.agw.piectrl.PiePart.GetLabel`                                     Returns the segment label.
:meth:`~wx.lib.agw.piectrl.PiePart.GetValue`                                     Returns the segment absolute value.
:meth:`~wx.lib.agw.piectrl.PiePart.SetColour`                                    Sets the segment colour.
:meth:`~wx.lib.agw.piectrl.PiePart.SetLabel`                                     Sets the segment label.
:meth:`~wx.lib.agw.piectrl.PiePart.SetValue`                                     Sets the segment absolute value.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: PiePart(object)

   This class handles the legend segments properties, such as value,
   colour and label.

   .. method:: __init__(self, value=0, colour=wx.BLACK, label="")

      Default class constructor.
      
      :param `value`: the pie part value;
      :param `colour`: the pie part colour;
      :param `label`: the pie part text label.


   .. method:: GetColour(self)

      Returns the segment colour. 


   .. method:: GetLabel(self)

      Returns the segment label. 


   .. method:: GetValue(self)

      Returns the segment absolute value. 


   .. method:: SetColour(self, colour)

      Sets the segment colour.
      
      :param `colour`: a valid :class:`wx.Colour` object.


   .. method:: SetLabel(self, label)

      Sets the segment label.
      
      :param `label`: the pie part text label.


   .. method:: SetValue(self, value)

      Sets the segment absolute value.
      
      :param `value`: a floating point number representing the :class:`PiePart` value.