*************
wx.ColourData
*************

Inheritance diagram for `wx.ColourData`:

|

.. inheritance-diagram:: wx.ColourData

|

Description
===========

This class holds a variety of information related to colour dialogs.


.. seealso:: `wx.Colour <wx.Colour.html>`_, `wx.ColourDialog <wx.ColourDialog.html>`_ 


Derived From
^^^^^^^^^^^^^

* `wx.Object <wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetChooseFull <#GetChooseFull>`_ 
* `GetColour <#GetColour>`_ 
* `GetCustomColour <#GetCustomColour>`_ 
* `SetChooseFull <#SetChooseFull>`_ 
* `SetColour <#SetColour>`_ 
* `SetCustomColour <#SetCustomColour>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `ChooseFull <#ChooseFull>`_ 
* `Colour <#Colour>`_ 
* `CustomColour <#CustomColour>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   Constructor, sets default values.
   
   |

   **Returns:**

   `wx.ColourData <wx.ColourData.html>`_
 

--------

.. method:: GetChooseFull()

   Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour 
   selection controls. Under PalmOS, determines whether colour dialog will display full rgb colour picker or 
   only available palette indexer. Has no meaning under other platforms.

   The default value is ``True``.

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetColour()

   Gets the current colour associated with the colour dialog.

   The default colour is black.

   |  

   **Returns:**

   `wx.Colour <wx.Colour.html>`_
 

--------

.. method:: GetCustomColour(i)

   Gets the i `th` custom colour associated with the colour dialog. `i` should be an integer between 0 and 15.

   The default custom colours are invalid colours.

   **Parameters:**

   * `i` (int) 

   |  

   **Returns:**

   `wx.Colour <wx.Colour.html>`_
 

--------

.. method:: SetChooseFull(flag)

   Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls. 
   Under other platforms, has no effect.

   The default value is ``True``.

   **Parameters:**

   * `flag` (bool) 

--------

.. method:: SetColour(colour)

   Sets the default colour for the colour dialog.

   The default colour is black.

   **Parameters:**

   * `colour` (`wx.Colour <wx.Colour.html>`_) 

--------

.. method:: SetCustomColour(i, colour)

   Sets the i `th` custom colour for the colour dialog. `i` should be an integer between 0 and 15.

   The default custom colours are invalid colours.

   **Parameters:**

   * `i` (int) 
   * `colour` (`wx.Colour <wx.Colour.html>`_) 

--------

Properties
^^^^^^^^^^


.. attribute:: ChooseFull

   See `GetChooseFull <#GetChooseFull>`_ and `SetChooseFull <#SetChooseFull>`_

.. attribute:: Colour

   See `GetColour <#GetColour>`_ and `SetColour <#SetColour>`_

.. attribute:: CustomColour

   See `GetCustomColour <#GetCustomColour>`_ and `SetCustomColour <#SetCustomColour>`_