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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
.. 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
.. _wx.ColourData:
==========================================================================================================================================
|phoenix_title| **wx.ColourData**
==========================================================================================================================================
This class holds a variety of information related to colour dialogs.
.. seealso:: :ref:`wx.Colour`, :ref:`wx.ColourDialog`, :ref:`ColourDialog Overview <colourdialog overview>`
|
|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>ColourData</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.ColourData_inheritance.png" alt="Inheritance diagram of ColourData" 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.ColourData.html" title="wx.ColourData" alt="" coords="5,83,124,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="21,5,108,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ColourData.__init__` Constructor.
:meth:`~wx.ColourData.FromString` Decodes the given string, which should be in the same format returned by :ref:`wx.ToString`, and sets the internal colours.
:meth:`~wx.ColourData.GetChooseAlpha` Indicates whether the colour dialog will display alpha values and an opacity selector.
:meth:`~wx.ColourData.GetChooseFull` Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls.
:meth:`~wx.ColourData.GetColour` Gets the current colour associated with the colour dialog.
:meth:`~wx.ColourData.GetCustomColour` Returns custom colours associated with the colour dialog.
:meth:`~wx.ColourData.SetChooseAlpha` Tells the colour dialog to show alpha values and an opacity selector (slider).
:meth:`~wx.ColourData.SetChooseFull` Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls.
:meth:`~wx.ColourData.SetColour` Sets the default colour for the colour dialog.
:meth:`~wx.ColourData.SetCustomColour` Sets custom colours for the colour dialog.
:meth:`~wx.ColourData.ToString` Converts the colours saved in this class in a string form, separating the various colours with a comma.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ColourData.ChooseAlpha` See :meth:`~wx.ColourData.GetChooseAlpha` and :meth:`~wx.ColourData.SetChooseAlpha`
:attr:`~wx.ColourData.ChooseFull` See :meth:`~wx.ColourData.GetChooseFull` and :meth:`~wx.ColourData.SetChooseFull`
:attr:`~wx.ColourData.Colour` See :meth:`~wx.ColourData.GetColour` and :meth:`~wx.ColourData.SetColour`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ColourData(Object)
**Possible constructors**::
ColourData()
This class holds a variety of information related to colour dialogs.
.. method:: __init__(self)
Constructor.
Initializes the custom colours to ``NullColour`` , the `data` colour setting to black, and the `choose` full setting to ``True``.
.. method:: FromString(self, str)
Decodes the given string, which should be in the same format returned by :ref:`wx.ToString`, and sets the internal colours.
:param `str`:
:type `str`: string
:rtype: `bool`
.. method:: GetChooseAlpha(self)
Indicates whether the colour dialog will display alpha values and an opacity selector.
It is meaningful under wxGTK, wxOSX and with regards to generic colour dialog.
The default value is ``False``, except wxOSX where it is ``True`` (for the sake of backward compatibility).
:rtype: `bool`
.. method:: GetChooseFull(self)
Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls.
Has no meaning under other platforms.
The default value is ``True``.
:rtype: `bool`
.. method:: GetColour(self)
Gets the current colour associated with the colour dialog.
The default colour is black.
:rtype: :ref:`wx.Colour`
.. method:: GetCustomColour(self, i)
Returns custom colours associated with the colour dialog.
:param `i`: An integer between 0 and 15, being any of the 15 custom colours that the user has saved. The default custom colours are invalid colours.
:type `i`: int
:rtype: :ref:`wx.Colour`
.. method:: SetChooseAlpha(self, flag)
Tells the colour dialog to show alpha values and an opacity selector (slider).
Currently it has effect under wxGTK, wxOSX and for generic colour dialog.
The default value is ``False``, except wxOSX where it is ``True`` for backward compatibility.
:param `flag`:
:type `flag`: bool
.. method:: SetChooseFull(self, flag)
Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls.
Under other platforms, has no effect.
The default value is ``True``.
:param `flag`:
:type `flag`: bool
.. method:: SetColour(self, colour)
Sets the default colour for the colour dialog.
The default colour is black.
:param `colour`:
:type `colour`: wx.Colour
.. method:: SetCustomColour(self, i, colour)
Sets custom colours for the colour dialog.
:param `i`: An integer between 0 and 15 for whatever custom colour you want to set. The default custom colours are invalid colours.
:type `i`: int
:param `colour`: The colour to set
:type `colour`: wx.Colour
.. method:: ToString(self)
Converts the colours saved in this class in a string form, separating the various colours with a comma.
:rtype: `string`
.. attribute:: ChooseAlpha
See :meth:`~wx.ColourData.GetChooseAlpha` and :meth:`~wx.ColourData.SetChooseAlpha`
.. attribute:: ChooseFull
See :meth:`~wx.ColourData.GetChooseFull` and :meth:`~wx.ColourData.SetChooseFull`
.. attribute:: Colour
See :meth:`~wx.ColourData.GetColour` and :meth:`~wx.ColourData.SetColour`
|
