.. 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.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

Inheritance diagram for class
ColourProperty:
|
|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: str=PG_LABEL, name: str=PG_LABEL, value:
Colour=WHITE) -> None
Allows to select a colour from the list or with colour dialog.
.. method:: __init__(self, label: str=PG_LABEL, name: str=PG_LABEL, value: Colour=WHITE)
:param `label`:
:type `label`: string
:param `name`:
:type `name`: string
:param `value`:
:type `value`: wx.Colour
:rtype: `None`
.. method:: GetColour(self, index : int)
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 : PGVariant, argFlags: int=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` .