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
315
316
317
318
319
320
321
322
|
.. 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.cubecolourdialog
.. highlight:: python
.. _wx.lib.agw.cubecolourdialog.CubeColourDialog:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.cubecolourdialog.CubeColourDialog**
==========================================================================================================================================
This is the CubeColourDialog main class implementation.
|
|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>CubeColourDialog</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.cubecolourdialog.CubeColourDialog_inheritance.png" alt="Inheritance diagram of CubeColourDialog" 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="55,5,156,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="107,83,217,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="102,160,223,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="180,5,261,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="118,237,207,267"/> <area shape="rect" id="node8" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="83,315,241,344"/> <area shape="rect" id="node6" href="wx.Dialog.html" title="wx.Dialog" alt="" coords="121,469,203,499"/> <area shape="rect" id="node9" href="wx.lib.agw.cubecolourdialog.CubeColourDialog.html" title="wx.lib.agw.cubecolourdialog.CubeColourDialog" alt="" coords="5,547,320,576"/> <area shape="rect" id="node7" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="91,392,233,421"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.lib.agw.cubecolourdialog.cubecolourdialog.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.cubecolourdialog.cubecolourdialog.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|super_classes| Known Superclasses
==================================
:class:`wx.Dialog`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.__init__` Default class constructor.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.AssignColourValue` Common code to handle spin control changes.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.CalcCuboid` Calculates the RGB colour cube vertices.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.CalcRects` Calculates the brightness control user-selected rect.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.CalcSlopes` Calculates the line slopes in the RGB colour cube.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.DoLayout` Layouts all the controls in the :class:`CubeColourDialog`.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.DrawAll` Draws all the custom controls after a colour change.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.DrawAlpha` Refreshes the alpha channel control.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.DrawBright` Refreshes the brightness control.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.DrawHSB` Refreshes the HSB colour wheel.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.DrawMarkers` Draws the markers for all the controls.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.DrawRGB` Refreshes the RGB colour cube.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.GetAGWWindowStyleFlag` Returns the :class:`CubeColourDialog` window style flags.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.GetColourData` Returns a wxPython compatible :class:`wx.ColourData`.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.GetHSVAColour` Returns a 4-elements tuple of hue, saturation, brightness, alpha components.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.GetRGBAColour` Returns a 4-elements tuple of red, green, blue, alpha components.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.InitDialog` Initialize the :class:`CubeColourDialog`.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.OnAddCustom` Handles the Add Custom ``wx.EVT_BUTTON`` event for :class:`CubeColourDialog`.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.OnAlphaSpin` Handles the ``wx.EVT_SPINCTRL`` event for the alpha channel.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.OnCancel` Handles the Cancel ``wx.EVT_BUTTON`` event for :class:`CubeColourDialog`.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.OnCloseWindow` Handles the ``wx.EVT_CLOSE`` event for :class:`CubeColourDialog`.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.OnKeyUp` Handles the ``wx.EVT_CHAR_HOOK`` event for :class:`CubeColourDialog`.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.OnOk` Handles the Ok ``wx.EVT_BUTTON`` event for :class:`CubeColourDialog`.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.OnShowAlpha` Shows/hides the alpha channel control in :class:`CubeColourDialog`.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.OnSpinCtrl` Handles the ``wx.EVT_SPINCTRL`` event for RGB and HSB colours.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.SetAGWWindowStyleFlag` Sets the :class:`CubeColourDialog` window style flags.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.SetCodes` Sets the HTML/MS Access codes (if any) in the text controls.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.SetPanelColours` Assigns colours to the colour panels.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.SetProperties` Sets some initial properties for :class:`CubeColourDialog` (sizes, values).
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.SetSpinVals` Sets the values for all the spin controls.
:meth:`~wx.lib.agw.cubecolourdialog.CubeColourDialog.ShowModal` Shows :class:`CubeColourDialog` as a modal dialog. Program flow does
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: CubeColourDialog(wx.Dialog)
This is the CubeColourDialog main class implementation.
.. method:: __init__(self, parent, colourData=None, agwStyle=CCD_SHOW_ALPHA)
Default class constructor.
:param `colourData`: a standard :class:`wx.ColourData` (as used in :class:`wx.ColourDialog`);
:param `agwStyle`: can be either ``None`` or ``CCD_SHOW_ALPHA``, depending if you want
to hide the alpha channel control or not.
.. method:: AssignColourValue(self, attribute, colourVal, maxVal, position)
Common code to handle spin control changes.
.. method:: CalcCuboid(self)
Calculates the RGB colour cube vertices.
.. method:: CalcRects(self)
Calculates the brightness control user-selected rect.
.. method:: CalcSlopes(self)
Calculates the line slopes in the RGB colour cube.
.. method:: DoLayout(self)
Layouts all the controls in the :class:`CubeColourDialog`.
.. method:: DrawAll(self)
Draws all the custom controls after a colour change.
.. method:: DrawAlpha(self)
Refreshes the alpha channel control.
.. method:: DrawBright(self)
Refreshes the brightness control.
.. method:: DrawHSB(self)
Refreshes the HSB colour wheel.
.. method:: DrawMarkers(self, dc=None)
Draws the markers for all the controls.
:param `dc`: an instance of :class:`wx.DC`. If `dc` is ``None``, a :class:`ClientDC` is
created on the fly.
.. method:: DrawRGB(self)
Refreshes the RGB colour cube.
.. method:: GetAGWWindowStyleFlag(self)
Returns the :class:`CubeColourDialog` window style flags.
:see: :meth:`~CubeColourDialog.SetAGWWindowStyleFlag` for a list of possible flags.
.. method:: GetColourData(self)
Returns a wxPython compatible :class:`wx.ColourData`.
.. method:: GetHSVAColour(self)
Returns a 4-elements tuple of hue, saturation, brightness, alpha components.
.. method:: GetRGBAColour(self)
Returns a 4-elements tuple of red, green, blue, alpha components.
.. method:: InitDialog(self)
Initialize the :class:`CubeColourDialog`.
.. method:: OnAddCustom(self, event)
Handles the Add Custom ``wx.EVT_BUTTON`` event for :class:`CubeColourDialog`.
:param `event`: a :class:`CommandEvent` event to be processed.
.. method:: OnAlphaSpin(self, event)
Handles the ``wx.EVT_SPINCTRL`` event for the alpha channel.
:param `event`: a :class:`SpinEvent` event to be processed.
.. method:: OnCancel(self, event)
Handles the Cancel ``wx.EVT_BUTTON`` event for :class:`CubeColourDialog`.
:param `event`: a :class:`CommandEvent` event to be processed.
.. method:: OnCloseWindow(self, event)
Handles the ``wx.EVT_CLOSE`` event for :class:`CubeColourDialog`.
:param `event`: a :class:`CloseEvent` event to be processed.
.. method:: OnKeyUp(self, event)
Handles the ``wx.EVT_CHAR_HOOK`` event for :class:`CubeColourDialog`.
:param `event`: a :class:`KeyEvent` event to be processed.
.. method:: OnOk(self, event)
Handles the Ok ``wx.EVT_BUTTON`` event for :class:`CubeColourDialog`.
:param `event`: a :class:`CommandEvent` event to be processed.
.. method:: OnShowAlpha(self, event)
Shows/hides the alpha channel control in :class:`CubeColourDialog`.
:param `event`: a :class:`CommandEvent` event to be processed.
.. method:: OnSpinCtrl(self, event)
Handles the ``wx.EVT_SPINCTRL`` event for RGB and HSB colours.
:param `event`: a :class:`SpinEvent` event to be processed.
.. method:: SetAGWWindowStyleFlag(self, agwStyle)
Sets the :class:`CubeColourDialog` window style flags.
:param `agwStyle`: can only be ``CCD_SHOW_ALPHA`` or ``None``.
.. method:: SetCodes(self)
Sets the HTML/MS Access codes (if any) in the text controls.
.. method:: SetPanelColours(self)
Assigns colours to the colour panels.
.. method:: SetProperties(self)
Sets some initial properties for :class:`CubeColourDialog` (sizes, values).
.. method:: SetSpinVals(self)
Sets the values for all the spin controls.
.. method:: ShowModal(self)
Shows :class:`CubeColourDialog` as a modal dialog. Program flow does
not return until the dialog has been dismissed with `EndModal`.
:note: Overridden from :class:`Dialog`.
|
