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
|
.. 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.ColourDialog:
==========================================================================================================================================
|phoenix_title| **wx.ColourDialog**
==========================================================================================================================================
This class represents the colour chooser dialog.
.. seealso:: :ref:`ColourDialog Overview <colourdialog overview>`, :ref:`wx.Colour`, :ref:`wx.ColourData`, :ref:`wx.GetColourFromUser`
|
|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>ColourDialog</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.ColourDialog_inheritance.png" alt="Inheritance diagram of ColourDialog" 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="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window" alt="" coords="69,160,157,189"/> <area shape="rect" id="node6" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="34,237,192,267"/> <area shape="rect" id="node5" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="42,315,184,344"/> <area shape="rect" id="node7" href="wx.Dialog.html" title="wx.Dialog" alt="" coords="72,392,153,421"/> <area shape="rect" id="node8" href="wx.ColourDialog.html" title="wx.ColourDialog" alt="" coords="52,469,175,499"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ColourDialog.__init__` Constructor.
:meth:`~wx.ColourDialog.Create` Same as :ref:`wx.ColourDialog`.
:meth:`~wx.ColourDialog.GetColourData` Returns the colour data associated with the colour dialog.
:meth:`~wx.ColourDialog.ShowModal` Shows the dialog, returning ``wx.ID_OK`` if the user pressed ``wx.OK``, and ``wx.ID_CANCEL`` otherwise.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ColourDialog.ColourData` See :meth:`~wx.ColourDialog.GetColourData`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ColourDialog(Dialog)
**Possible constructors**::
ColourDialog(parent, data=None)
This class represents the colour chooser dialog.
.. method:: __init__(self, parent, data=None)
Constructor.
Pass a parent window, and optionally a pointer to a block of colour data, which will be copied to the colour dialog's colour data.
Custom colours from colour data object will be used in the dialog's colour palette. Invalid entries in custom colours list will be ignored on some platforms(GTK) or replaced with white colour on platforms where custom colours palette has fixed size (MSW).
:param `parent`:
:type `parent`: wx.Window
:param `data`:
:type `data`: wx.ColourData
.. seealso:: :ref:`wx.ColourData`
.. method:: Create(self, parent, data=None)
Same as :ref:`wx.ColourDialog`.
:param `parent`:
:type `parent`: wx.Window
:param `data`:
:type `data`: wx.ColourData
:rtype: `bool`
.. method:: GetColourData(self)
Returns the colour data associated with the colour dialog.
:rtype: :ref:`wx.ColourData`
.. method:: ShowModal(self)
Shows the dialog, returning ``wx.ID_OK`` if the user pressed ``wx.OK``, and ``wx.ID_CANCEL`` otherwise.
:rtype: `int`
.. attribute:: ColourData
See :meth:`~wx.ColourDialog.GetColourData`
|
