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
|
.. 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.colourchooser.pycolourslider
.. highlight:: python
.. _wx.lib.colourchooser.pycolourslider.PyColourSlider:
==========================================================================================================================================
|phoenix_title| **wx.lib.colourchooser.pycolourslider.PyColourSlider**
==========================================================================================================================================
A Pure-Python Colour Slider
The colour slider displays transitions from value 0 to value 1 in
HSV, allowing the user to select a colour within the transition
spectrum.
This class is best accompanying by a wxSlider that allows the user
to select a particular colour shade.
|
|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>PyColourSlider</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.colourchooser.pycolourslider.PyColourSlider_inheritance.png" alt="Inheritance diagram of PyColourSlider" 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="65,5,167,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="117,83,228,112"/> <area shape="rect" id="node6" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="113,160,233,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="191,5,272,35"/> <area shape="rect" id="node4" href="wx.lib.colourchooser.pycolourslider.PyColourSlider.html" title="wx.lib.colourchooser.pycolourslider.PyColourSlider" alt="" coords="5,392,341,421"/> <area shape="rect" id="node5" href="wx.lib.colourchooser.canvas.Canvas.html" title="wx.lib.colourchooser.canvas.Canvas" alt="" coords="49,315,297,344"/> <area shape="rect" id="node7" href="wx.Window.html" title="wx.Window" alt="" coords="129,237,217,267"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.colourchooser.canvas.Canvas`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.colourchooser.pycolourslider.PyColourSlider.__init__` Creates a blank slider instance. A colour must be set before the
:meth:`~wx.lib.colourchooser.pycolourslider.PyColourSlider.DrawBuffer` Actual implementation of the widget's drawing. We simply draw
:meth:`~wx.lib.colourchooser.pycolourslider.PyColourSlider.GetBaseColour` Return the current colour used as a colour base for filling out
:meth:`~wx.lib.colourchooser.pycolourslider.PyColourSlider.GetVFromClick` Returns the HSV value "V" based on the location of a mouse click at y offset "pos"
:meth:`~wx.lib.colourchooser.pycolourslider.PyColourSlider.SetBaseColour` Sets the base, or target colour, to use as the central colour
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: PyColourSlider(canvas.Canvas)
A Pure-Python Colour Slider
The colour slider displays transitions from value 0 to value 1 in
HSV, allowing the user to select a colour within the transition
spectrum.
This class is best accompanying by a wxSlider that allows the user
to select a particular colour shade.
.. method:: __init__(self, parent, id, colour=None)
Creates a blank slider instance. A colour must be set before the
slider will be filled in.
.. method:: DrawBuffer(self)
Actual implementation of the widget's drawing. We simply draw
from value 0.0 to value 1.0 in HSV.
.. method:: GetBaseColour(self)
Return the current colour used as a colour base for filling out
the slider.
.. method:: GetVFromClick(self, pos)
Returns the HSV value "V" based on the location of a mouse click at y offset "pos"
.. method:: SetBaseColour(self, colour)
Sets the base, or target colour, to use as the central colour
when calculating colour transitions.
|
