.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 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

Inheritance diagram for class
PyColourSlider:
|
|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.