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
|
.. 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.ColourDatabase:
==========================================================================================================================================
|phoenix_title| **wx.ColourDatabase**
==========================================================================================================================================
wxWidgets maintains a database of standard ``RGB`` colours for a predefined set of named colours.
The application may add to this set if desired by using :meth:`~wx.ColourDatabase.AddColour` and may use it to look up colours by names using :meth:`~wx.ColourDatabase.Find` or find the names for the standard colour using :meth:`~wx.ColourDatabase.FindName`.
There is one predefined, global instance of this class called :ref:`wx.TheColourDatabase`.
The standard database contains at least the following colours:
.. include:: rest_substitutions/tables/wx.ColourDatabase.1.rst
.. seealso:: :ref:`wx.Colour`
|
|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>ColourDatabase</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.ColourDatabase_inheritance.png" alt="Inheritance diagram of ColourDatabase" 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.ColourDatabase.html" title="wx.ColourDatabase" alt="" coords="5,5,149,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ColourDatabase.__init__` Constructs the colour database.
:meth:`~wx.ColourDatabase.AddColour` Adds a colour to the database.
:meth:`~wx.ColourDatabase.Find` Finds a colour given the name.
:meth:`~wx.ColourDatabase.FindColour`
:meth:`~wx.ColourDatabase.FindName` Finds a colour name given the colour.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ColourDatabase(object)
**Possible constructors**::
ColourDatabase()
wxWidgets maintains a database of standard ``RGB`` colours for a
predefined set of named colours.
.. method:: __init__(self)
Constructs the colour database.
It will be initialized at the first use.
.. method:: AddColour(self, colourName, colour)
Adds a colour to the database.
If a colour with the same name already exists, it is replaced.
:param `colourName`:
:type `colourName`: string
:param `colour`:
:type `colour`: wx.Colour
.. method:: Find(self, colourName)
Finds a colour given the name.
Returns an invalid colour object (that is, :meth:`wx.Colour.IsOk` will return ``False``) if the colour wasn't found in the database.
:param `colourName`:
:type `colourName`: string
:rtype: :ref:`wx.Colour`
.. method:: FindColour(self, colour)
.. method:: FindName(self, colour)
Finds a colour name given the colour.
Returns an empty string if the colour is not found in the database.
:param `colour`:
:type `colour`: wx.Colour
:rtype: `string`
|
