.. 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.colourselect
.. highlight:: python
.. _wx.lib.colourselect.ColourSelectEvent:
==========================================================================================================================================
|phoenix_title| **wx.lib.colourselect.ColourSelectEvent**
==========================================================================================================================================
:class:`wx.ColourSelectEvent` is a special subclassing of :class:`wx.CommandEvent`
and it provides for a custom event sent every time the user chooses a colour.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
ColourSelectEvent:
|
|super_classes| Known Superclasses
==================================
:class:`wx.PyCommandEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.colourselect.ColourSelectEvent.__init__` Default class constructor.
:meth:`~wx.lib.colourselect.ColourSelectEvent.GetValue` Returns the currently selected colour.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ColourSelectEvent(wx.PyCommandEvent)
:class:`wx.ColourSelectEvent` is a special subclassing of :class:`wx.CommandEvent`
and it provides for a custom event sent every time the user chooses a colour.
.. method:: __init__(self, id, value)
Default class constructor.
:param integer `id`: the event identifier;
:param wx.Colour `value`: the colour currently selected.
.. method:: GetValue(self)
Returns the currently selected colour.
:rtype: :class:`wx.Colour`