.. 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
.. _wx.ColourDialogEvent:
==========================================================================================================================================
|phoenix_title| **wx.ColourDialogEvent**
==========================================================================================================================================
This event class is used for the events generated by :ref:`wx.ColourDialog`.
.. _ColourDialogEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.ColourPickerEvent` parameter.
- EVT_COLOUR_CHANGED: Generated whenever the currently selected colour in the dialog changes. This event is currently only implemented in wxMSW.
.. versionadded:: 4.1/wxWidgets-3.1.3
.. seealso:: :ref:`wx.ColourDialog`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
ColourDialogEvent:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ColourDialogEvent.__init__`
:meth:`~wx.ColourDialogEvent.GetColour` Retrieve the colour the user has just selected.
:meth:`~wx.ColourDialogEvent.SetColour` Set the colour to be sent with the event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ColourDialogEvent.Colour` See :meth:`~wx.ColourDialogEvent.GetColour` and :meth:`~wx.ColourDialogEvent.SetColour`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ColourDialogEvent(CommandEvent)
**Possible constructors**::
ColourDialogEvent() -> None
ColourDialogEvent(evtType : EventType, dialog : ColourDialog, colour :
Colour) -> None
This event class is used for the events generated by ColourDialog.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self)`
:rtype: `None`
:html:`
`
**__init__** `(self, evtType : EventType, dialog : ColourDialog, colour : Colour)`
The constructor is not normally used by the user code.
:param `evtType`:
:type `evtType`: wx.EventType
:param `dialog`:
:type `dialog`: wx.ColourDialog
:param `colour`:
:type `colour`: wx.Colour
:rtype: `None`
:html:`
`
.. method:: GetColour(self)
Retrieve the colour the user has just selected.
:rtype: :ref:`wx.Colour`
.. method:: SetColour(self, colour : Colour)
Set the colour to be sent with the event.
:param `colour`:
:type `colour`: wx.Colour
:rtype: `None`
.. attribute:: Colour
See :meth:`~wx.ColourDialogEvent.GetColour` and :meth:`~wx.ColourDialogEvent.SetColour`