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
|
.. 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
.. _wx.propgrid.ColourProperty:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.ColourProperty**
==========================================================================================================================================
|
|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>ColourProperty</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.propgrid.ColourProperty_inheritance.png" alt="Inheritance diagram of ColourProperty" 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.propgrid.ColourProperty.html" title="wx.propgrid.ColourProperty" alt="" coords="29,315,224,344"/> <area shape="rect" id="node2" href="wx.propgrid.SystemColourProperty.html" title="wx.propgrid.SystemColourProperty" alt="" coords="5,237,248,267"/> <area shape="rect" id="node3" href="wx.propgrid.EnumProperty.html" title="wx.propgrid.EnumProperty" alt="" coords="31,160,221,189"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="85,5,167,35"/> <area shape="rect" id="node5" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty" alt="" coords="41,83,212,112"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.ColourProperty.__init__`
:meth:`~wx.propgrid.ColourProperty.GetColour` Default is to use `SystemSettings.GetColour(index).`
:meth:`~wx.propgrid.ColourProperty.ValueToString` Converts property value into a text representation.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.ColourProperty(SystemColourProperty)
**Possible constructors**::
ColourProperty(label=PG_LABEL, name=PG_LABEL, value=WHITE)
.. method:: __init__(self, label=PG_LABEL, name=PG_LABEL, value=WHITE)
:param `label`:
:type `label`: string
:param `name`:
:type `name`: string
:param `value`:
:type `value`: wx.Colour
.. method:: GetColour(self, index)
Default is to use `SystemSettings.GetColour(index).`
Override to use custom colour tables etc.
:param `index`:
:type `index`: int
:rtype: :ref:`Colour`
.. method:: ValueToString(self, value, argFlags=0)
Converts property value into a text representation.
:param `value`: Value to be converted.
:type `value`: PGVariant
:param `argFlags`: If 0 (default value), then displayed string is returned. If ``wx.propgrid.PG_FULL_VALUE`` is set, returns complete, storable string value instead of displayable. If ``wx.propgrid.PG_EDITABLE_VALUE`` is set, returns string value that must be editable in textctrl. If ``wx.propgrid.PG_COMPOSITE_FRAGMENT`` is set, returns text that is appropriate to display as a part of string property's composite text representation.
:type `argFlags`: int
:rtype: `string`
.. note::
Default implementation calls :meth:`GenerateComposedValue` .
|
