.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2017 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.ColourPickerEvent:
==========================================================================================================================================
|phoenix_title| **wx.ColourPickerEvent**
==========================================================================================================================================
This event class is used for the events generated by :ref:`wx.ColourPickerCtrl`.
.. _ColourPickerEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.ColourPickerEvent` parameter.
- EVT_COLOURPICKER_CHANGED: Generated whenever the selected colour changes.
.. seealso:: :ref:`wx.ColourPickerCtrl`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
Inheritance diagram for class
ColourPickerEvent:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ColourPickerEvent.__init__`
:meth:`~wx.ColourPickerEvent.GetColour` Retrieve the colour the user has just selected.
:meth:`~wx.ColourPickerEvent.SetColour` Set the colour associated with the event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ColourPickerEvent.Colour` See :meth:`~wx.ColourPickerEvent.GetColour` and :meth:`~wx.ColourPickerEvent.SetColour`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ColourPickerEvent(CommandEvent)
**Possible constructors**::
ColourPickerEvent()
ColourPickerEvent(generator, id, colour)
This event class is used for the events generated by
ColourPickerCtrl.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
**~~~**
**__init__** `(self, generator, id, colour)`
The constructor is not normally used by the user code.
:param `generator`:
:type `generator`: wx.Object
:param `id`:
:type `id`: int
:param `colour`:
:type `colour`: wx.Colour
**~~~**
.. method:: GetColour(self)
Retrieve the colour the user has just selected.
:rtype: :ref:`wx.Colour`
.. method:: SetColour(self, pos)
Set the colour associated with the event.
:param `pos`:
:type `pos`: wx.Colour
.. attribute:: Colour
See :meth:`~wx.ColourPickerEvent.GetColour` and :meth:`~wx.ColourPickerEvent.SetColour`