.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2025 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.propgrid.ColourProperty:

==========================================================================================================================================
|phoenix_title|  **wx.propgrid.ColourProperty**
==========================================================================================================================================

Allows to select a colour from the list or with colour dialog. 
         

Value used is of :ref:`wx.propgrid.ColourPropertyValue`  type. 

**Supported special attributes:**  ``PG_COLOUR_ALLOW_CUSTOM``, ``PG_COLOUR_HAS_ALPHA``  
          




|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div class="collabsible-wrapper">
      <input id="collapsible-inheritance" class="collapsible-checkbox" type="checkbox">
      <label for="collapsible-inheritance" tabindex="0" title="Show inheritance diagram" class="collapsible-label">Inheritance diagram for class <strong>ColourProperty</strong>:</label>
      <div class="collapsible-content">
         <p class="graphviz">
            <center><img src="_static/images/inheritance/wx.propgrid.ColourProperty_inheritance.svg" alt="Inheritance diagram of ColourProperty" usemap="#dummy" class="inheritance invert-in-dark-mode"/></center>
            <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.propgrid.ColourProperty.html" title="Allows to select a colour from the list or with colour dialog." alt="" coords="32,313,256,341"/> <area shape="rect" id="node2" href="wx.propgrid.SystemColourProperty.html" title="Has dropdown list of wxWidgets system colours." alt="" coords="5,236,282,265"/> <area shape="rect" id="node3" href="wx.propgrid.EnumProperty.html" title="You can derive custom properties with choices from this class." alt="" coords="35,159,253,188"/> <area shape="rect" id="node4" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty  is base class for all wx.propgrid.PropertyGrid  properties and as such it is not intended to be instantiated directly." alt="" coords="44,82,243,111"/> <area shape="rect" id="node5" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="94,5,193,34"/> </map> 
         </p>
      </div>
   </div>
   <script type="text/javascript" src="_static/inheritancetoggle.js"></script>



|


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

================================================================================ ================================================================================
:meth:`~wx.propgrid.ColourProperty.__init__`                                     
:meth:`~wx.propgrid.ColourProperty.GetColour`                                    Default is to use `SystemSettings.GetColour(index).`
:meth:`~wx.propgrid.ColourProperty.ValueToString`                                Converts property value into a text representation.
================================================================================ ================================================================================


|


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


.. class:: wx.propgrid.ColourProperty(SystemColourProperty)

   **Possible constructors**::

       ColourProperty(label=PG_LABEL, name=PG_LABEL, value=WHITE) -> None
       
   
   Allows to select a colour from the list or with colour dialog.



   .. method:: __init__(self, label=PG_LABEL, name=PG_LABEL, value=WHITE)




      :param `label`: 
      :type `label`: string
      :param `name`: 
      :type `name`: string
      :param `value`: 
      :type `value`: wx.Colour




      :rtype: `None`     








   .. method:: GetColour(self, index)

      Default is to use `SystemSettings.GetColour(index).` 
                 

      Override to use custom colour tables etc. 
                 


      :param `index`: 
      :type `index`: int




      :rtype: `Colour`     








   .. method:: ValueToString(self, value, argFlags=0)

      Converts property value into a text representation. 
                 




      :param `value`: Value to be converted.   
      :type `value`: PGVariant
      :param `argFlags`: If 0 (default value), then displayed string is returned. If ``PG_FULL_VALUE``  is set, returns complete, storable string value instead of displayable. If ``PG_EDITABLE_VALUE``  is set, returns string value that must be editable in textctrl. If ``PG_COMPOSITE_FRAGMENT``  is set, returns text that is appropriate to display as a part of string property's composite text representation.  
      :type `argFlags`: int








      :rtype: `str`




                  



      .. note:: 

         Default implementation calls :meth:`GenerateComposedValue` .