.. include:: headings.inc



.. _ColourPickerEvent:

==========================================================================================================================================
|phoenix_title|  **ColourPickerEvent**
==========================================================================================================================================

This event class is used for the events generated by :ref:`ColourPickerCtrl`.          





.. _ColourPickerEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`ColourPickerEvent` parameter.

- EVT_COLOURPICKER_CHANGED: Generated whenever the selected colour changes.  








         



.. seealso:: :ref:`ColourPickerCtrl`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **ColourPickerEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/ColourPickerEvent_inheritance.png" alt="Inheritance diagram of ColourPickerEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="125,5,197,35"/> <area shape="rect" id="node4" href="CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="245,5,381,35"/> <area shape="rect" id="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> <area shape="rect" id="node6" href="ColourPickerEvent.html" title="This event class is used for the events generated by ColourPickerCtrl." alt="" coords="429,5,587,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~ColourPickerEvent.__init__`                                              
:meth:`~ColourPickerEvent.GetColour`                                             Retrieve the colour the user has just selected.
:meth:`~ColourPickerEvent.SetColour`                                             Set the colour associated with the event.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~ColourPickerEvent.Colour`                                                See :meth:`~ColourPickerEvent.GetColour` and :meth:`~ColourPickerEvent.SetColour`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: ColourPickerEvent(CommandEvent)

   This event class is used for the events generated by ColourPickerCtrl.
   
   **Possible constructors**::

       ColourPickerEvent()
       
       ColourPickerEvent(generator, id, colour)
       



   .. 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`: Object
      :param `id`: 
      :type `id`: int
      :param `colour`: 
      :type `colour`: Colour
      
      
      
      
      
      
      **~~~**






   .. method:: GetColour(self)

      Retrieve the colour the user has just selected.                  

      :rtype: :ref:`Colour`








   .. method:: SetColour(self, pos)

      Set the colour associated with the event.                  


      :param `pos`: 
      :type `pos`: Colour







   .. attribute:: Colour

      See :meth:`~ColourPickerEvent.GetColour` and :meth:`~ColourPickerEvent.SetColour`