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
|
.. 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.BasePyControl:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.cubecolourdialog.BasePyControl**
==========================================================================================================================================
Base class used to hold common code for the HSB colour wheel and the RGB
colour cube.
|
|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>BasePyControl</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.BasePyControl_inheritance.png" alt="Inheritance diagram of BasePyControl" 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="44,5,145,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="96,83,207,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="91,160,212,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="169,5,251,35"/> <area shape="rect" id="node6" href="wx.Window.html" title="wx.Window" alt="" coords="107,237,196,267"/> <area shape="rect" id="node5" href="wx.Control.html" title="wx.Control" alt="" coords="108,315,196,344"/> <area shape="rect" id="node7" href="wx.lib.agw.cubecolourdialog.BasePyControl.html" title="wx.lib.agw.cubecolourdialog.BasePyControl" alt="" coords="5,392,299,421"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.cubecolourdialog.HSVWheel`, :class:`wx.lib.agw.cubecolourdialog.RGBCube`
|
|super_classes| Known Superclasses
==================================
:class:`wx.Control`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.__init__` Default class constructor.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.AcceptsFocus` Can this window be given focus by mouse click?
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.AcceptsFocusFromKeyboard` Can this window be given focus by keyboard navigation? If not, the
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.DoGetBestSize` Overridden base class virtual. Determines the best size of the
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.DrawLines` Draws the lines connecting the markers on top of the background bitmap.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.DrawMarkers` Draws the markers on top of the background bitmap.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnEraseBackground` Handles the ``wx.EVT_ERASE_BACKGROUND`` for :class:`BasePyControl`.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnLeftDown` Handles the ``wx.EVT_LEFT_DOWN`` for :class:`BasePyControl`.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnLeftUp` Handles the ``wx.EVT_LEFT_UP`` for :class:`BasePyControl`.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnMotion` Handles the ``wx.EVT_MOTION`` for :class:`BasePyControl`.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnPaint` Handles the ``wx.EVT_PAINT`` for :class:`BasePyControl`.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnSize` Handles the ``wx.EVT_SIZE`` for :class:`BasePyControl`.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: BasePyControl(wx.Control)
Base class used to hold common code for the HSB colour wheel and the RGB
colour cube.
.. method:: __init__(self, parent, bitmap=None)
Default class constructor.
Used internally. Do not call it in your code!
:param `parent`: the control parent;
:param `bitmap`: the background bitmap for this custom control.
.. method:: AcceptsFocus(self)
Can this window be given focus by mouse click?
:note: This method always returns ``False`` as we do not accept focus from
mouse click.
:note: Overridden from :class:`wx.Control`.
.. method:: AcceptsFocusFromKeyboard(self)
Can this window be given focus by keyboard navigation? If not, the
only way to give it focus (provided it accepts it at all) is to click
it.
:note: This method always returns ``False`` as we do not accept focus from
the keyboard.
:note: Overridden from :class:`wx.Control`.
.. method:: DoGetBestSize(self)
Overridden base class virtual. Determines the best size of the
control based on the bitmap size.
:note: Overridden from :class:`wx.Control`.
.. method:: DrawLines(self, dc)
Draws the lines connecting the markers on top of the background bitmap.
:param `dc`: an instance of :class:`wx.DC`.
:note: This method must be overridden in derived classes.
.. method:: DrawMarkers(self, dc=None)
Draws the markers on top of the background bitmap.
:param `dc`: an instance of :class:`wx.DC`.
:note: This method must be overridden in derived classes.
.. method:: OnEraseBackground(self, event)
Handles the ``wx.EVT_ERASE_BACKGROUND`` for :class:`BasePyControl`.
:param `event`: a :class:`EraseEvent` event to be processed.
:note: This is intentionally empty to reduce flicker.
.. method:: OnLeftDown(self, event)
Handles the ``wx.EVT_LEFT_DOWN`` for :class:`BasePyControl`.
:param `event`: a :class:`MouseEvent` event to be processed.
:note: This method must be overridden in derived classes.
.. method:: OnLeftUp(self, event)
Handles the ``wx.EVT_LEFT_UP`` for :class:`BasePyControl`.
:param `event`: a :class:`MouseEvent` event to be processed.
:note: This method must be overridden in derived classes.
.. method:: OnMotion(self, event)
Handles the ``wx.EVT_MOTION`` for :class:`BasePyControl`.
:param `event`: a :class:`MouseEvent` event to be processed.
:note: This method must be overridden in derived classes.
.. method:: OnPaint(self, event)
Handles the ``wx.EVT_PAINT`` for :class:`BasePyControl`.
:param `event`: a :class:`PaintEvent` event to be processed.
.. method:: OnSize(self, event)
Handles the ``wx.EVT_SIZE`` for :class:`BasePyControl`.
:param `event`: a :class:`wx.SizeEvent` event to be processed.
|
