.. include:: headings.inc



.. _ColourDialog:

==========================================================================================================================================
|phoenix_title|  **ColourDialog**
==========================================================================================================================================

This class represents the colour chooser dialog.          







         



.. seealso:: :ref:`ColourDialog Overview <colourdialog overview>`, :ref:`Colour`, :ref:`ColourData`, :func:`GetColourFromUser`    







|

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

Inheritance diagram for class **ColourDialog**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/ColourDialog_inheritance.png" alt="Inheritance diagram of ColourDialog" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,5,99,35"/> <area shape="rect" id="node4" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="148,31,247,62"/> <area shape="rect" id="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="16,58,88,89"/> <area shape="rect" id="node3" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="297,31,377,62"/> <area shape="rect" id="node7" href="NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="427,31,587,62"/> <area shape="rect" id="node6" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="636,31,780,62"/> <area shape="rect" id="node11" href="Dialog.html" title="A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen." alt="" coords="829,31,901,62"/> <area shape="rect" id="node13" href="ColourDialog.html" title="This class represents the colour chooser dialog." alt="" coords="951,31,1065,62"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~ColourDialog.__init__`                                                   Constructor.
:meth:`~ColourDialog.Create`                                                     Same as :ref:`ColourDialog` .
:meth:`~ColourDialog.GetColourData`                                              Returns the colour data associated with the colour dialog.
:meth:`~ColourDialog.ShowModal`                                                  Shows the dialog, returning ``ID_OK`` if the user pressed ``OK``, and ``ID_CANCEL`` otherwise.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~ColourDialog.ColourData`                                                 See :meth:`~ColourDialog.GetColourData`
================================================================================ ================================================================================


|


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

.. class:: ColourDialog(Dialog)

   This class represents the colour chooser dialog.
   
   **Possible constructors**::

       ColourDialog(parent, data=None)
       



   .. method:: __init__(self, parent, data=None)

      Constructor.                  

      Pass a parent window, and optionally a pointer to a block of colour data, which will be copied to the colour dialog's colour data. 

      Custom colours from colour data object will be used in the dialog's colour palette. Invalid entries in custom colours list will be ignored on some platforms(GTK) or replaced with white colour on platforms where custom colours palette has fixed size (MSW). 

                


      :param `parent`: 
      :type `parent`: Window
      :param `data`: 
      :type `data`: ColourData






      .. seealso:: :ref:`ColourData`    








   .. method:: Create(self, parent, data=None)

      Same as :ref:`ColourDialog` .                  


      :param `parent`: 
      :type `parent`: Window
      :param `data`: 
      :type `data`: ColourData




      :rtype: `bool`








   .. method:: GetColourData(self)

      Returns the colour data associated with the colour dialog.                  

      :rtype: :ref:`ColourData`








   .. method:: ShowModal(self)

      Shows the dialog, returning ``ID_OK`` if the user pressed ``OK``, and ``ID_CANCEL`` otherwise.                  

      :rtype: `int`








   .. attribute:: ColourData

      See :meth:`~ColourDialog.GetColourData`