.. include:: headings.inc



.. _ColourData:

==========================================================================================================================================
|phoenix_title|  **ColourData**
==========================================================================================================================================

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







         



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







|

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

Inheritance diagram for class **ColourData**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/ColourData_inheritance.png" alt="Inheritance diagram of ColourData" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="ColourData.html" title="This class holds a variety of information related to colour dialogs." alt="" coords="125,5,229,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"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~ColourData.__init__`                                                     Constructor.
:meth:`~ColourData.FromString`                                                   Decodes the given string, which should be in the same format returned by :meth:`ToString` , and sets the internal colours.
:meth:`~ColourData.GetChooseFull`                                                Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls.
:meth:`~ColourData.GetColour`                                                    Gets the current colour associated with the colour dialog.
:meth:`~ColourData.GetCustomColour`                                              Returns custom colours associated with the colour dialog.
:meth:`~ColourData.SetChooseFull`                                                Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls.
:meth:`~ColourData.SetColour`                                                    Sets the default colour for the colour dialog.
:meth:`~ColourData.SetCustomColour`                                              Sets custom colours for the colour dialog.
:meth:`~ColourData.ToString`                                                     Converts the colours saved in this class in a string form, separating the various colours with a comma.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~ColourData.ChooseFull`                                                   See :meth:`~ColourData.GetChooseFull` and :meth:`~ColourData.SetChooseFull`
:attr:`~ColourData.Colour`                                                       See :meth:`~ColourData.GetColour` and :meth:`~ColourData.SetColour`
================================================================================ ================================================================================


|


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

.. class:: ColourData(Object)

   This class holds a variety of information related to colour dialogs.
   
   **Possible constructors**::

       ColourData()
       



   .. method:: __init__(self)

      Constructor.                  

      Initializes the custom colours to  ``NullColour`` , the  `data`  colour setting to black, and the `choose`  full setting to ``True``.                   





   .. method:: FromString(self, str)

      Decodes the given string, which should be in the same format returned by :meth:`ToString` , and sets the internal colours.                  


      :param `str`: 
      :type `str`: string




      :rtype: `bool`








   .. method:: GetChooseFull(self)

      Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls.                  

      Has no meaning under other platforms. 

      The default value is ``True``.                  

      :rtype: `bool`








   .. method:: GetColour(self)

      Gets the current colour associated with the colour dialog.                  

      The default colour is black.                  

      :rtype: :ref:`Colour`








   .. method:: GetCustomColour(self, i)

      Returns custom colours associated with the colour dialog.                  




      :param `i`: An integer between 0 and 15, being any of the 15 custom colours that the user has saved. The default custom colours are invalid colours.   
      :type `i`: int






      :rtype: :ref:`Colour`



                  





   .. method:: SetChooseFull(self, 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``.                  


      :param `flag`: 
      :type `flag`: bool







   .. method:: SetColour(self, colour)

      Sets the default colour for the colour dialog.                  

      The default colour is black.                  


      :param `colour`: 
      :type `colour`: Colour







   .. method:: SetCustomColour(self, i, colour)

      Sets custom colours for the colour dialog.                  




      :param `i`: An integer between 0 and 15 for whatever custom colour you want to set. The default custom colours are invalid colours.   
      :type `i`: int
      :param `colour`: The colour to set   
      :type `colour`: Colour






                  





   .. method:: ToString(self)

      Converts the colours saved in this class in a string form, separating the various colours with a comma.                  

      :rtype: `string`








   .. attribute:: ChooseFull

      See :meth:`~ColourData.GetChooseFull` and :meth:`~ColourData.SetChooseFull`


   .. attribute:: Colour

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