.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2017 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.ColourPickerCtrl:
==========================================================================================================================================
|phoenix_title| **wx.ColourPickerCtrl**
==========================================================================================================================================
This control allows the user to select a colour.
The generic implementation is a button which brings up a :ref:`wx.ColourDialog` when clicked. Native implementation may differ but this is usually a (small) widget which give access to the colour-chooser dialog. It is only available if ``USE_COLOURPICKERCTRL`` is set to 1 (the default).
.. _ColourPickerCtrl-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.CLRP_DEFAULT_STYLE``: The default style: 0.
- ``wx.CLRP_USE_TEXTCTRL``: Creates a text control to the left of the picker button which is completely managed by the :ref:`wx.ColourPickerCtrl` and which can be used by the user to specify a colour (see SetColour). The text control is automatically synchronized with button's value. Use functions defined in :ref:`wx.PickerBase` to modify the text control.
- ``wx.CLRP_SHOW_LABEL``: Shows the colour in HTML form (``AABBCC``) as colour button label (instead of no label at all).
.. _ColourPickerCtrl-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.ColourPickerEvent` parameter.
- EVT_COLOURPICKER_CHANGED: The user changed the colour selected in the control either using the button or using text control (see ``CLRP_USE_TEXTCTRL`` ; note that in this case the event is fired only if the user’s input is valid, i.e. recognizable).
.. seealso:: :ref:`wx.ColourDialog`, :ref:`wx.ColourPickerEvent`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>ColourPickerCtrl</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.ColourPickerCtrl_inheritance.png" alt="Inheritance diagram of ColourPickerCtrl" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="61,237,149,267"/> <area shape="rect" id="node7" href="wx.PickerBase.html" title="Base abstract class for all pickers which support an auxiliary text control." alt="" coords="49,315,161,344"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window is the base class for all windows and represents any visible object on screen." alt="" coords="61,160,150,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,88,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="49,83,161,112"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="113,5,215,35"/> <area shape="rect" id="node6" href="wx.ColourPickerCtrl.html" title="This control allows the user to select a colour." alt="" coords="34,392,177,421"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.colourpickerctrl.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/wx.colourpickerctrl.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.colourpickerctrl.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ColourPickerCtrl.__init__`
:meth:`~wx.ColourPickerCtrl.Create` Creates a colour picker with the given arguments.
:meth:`~wx.ColourPickerCtrl.GetColour` Returns the currently selected colour.
:meth:`~wx.ColourPickerCtrl.SetColour` Sets the currently selected colour.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ColourPickerCtrl.Colour` See :meth:`~wx.ColourPickerCtrl.GetColour` and :meth:`~wx.ColourPickerCtrl.SetColour`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ColourPickerCtrl(PickerBase)
**Possible constructors**::
ColourPickerCtrl()
ColourPickerCtrl(parent, id=ID_ANY, colour=BLACK, pos=DefaultPosition,
size=DefaultSize, style=CLRP_DEFAULT_STYLE, validator=DefaultValidator,
name=ColourPickerCtrlNameStr)
This control allows the user to select a colour.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
**~~~**
**__init__** `(self, parent, id=ID_ANY, colour=BLACK, pos=DefaultPosition, size=DefaultSize, style=CLRP_DEFAULT_STYLE, validator=DefaultValidator, name=ColourPickerCtrlNameStr)`
Initializes the object and calls :meth:`Create` with all the parameters.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `colour`:
:type `colour`: wx.Colour
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `validator`:
:type `validator`: wx.Validator
:param `name`:
:type `name`: string
**~~~**
.. method:: Create(self, parent, id=ID_ANY, colour=BLACK, pos=DefaultPosition, size=DefaultSize, style=CLRP_DEFAULT_STYLE, validator=DefaultValidator, name=ColourPickerCtrlNameStr)
Creates a colour picker with the given arguments.
:param `parent`: Parent window, must not be not ``None``.
:type `parent`: wx.Window
:param `id`: The identifier for the control.
:type `id`: wx.WindowID
:param `colour`: The initial colour shown in the control.
:type `colour`: wx.Colour
:param `pos`: Initial position.
:type `pos`: wx.Point
:param `size`: Initial size.
:type `size`: wx.Size
:param `style`: The window style, see ``CRLP_`` flags.
:type `style`: long
:param `validator`: Validator which can be used for additional date checks.
:type `validator`: wx.Validator
:param `name`: Control name.
:type `name`: string
:rtype: `bool`
:returns:
``True`` if the control was successfully created or ``False`` if creation failed.
.. method:: GetColour(self)
Returns the currently selected colour.
:rtype: :ref:`wx.Colour`
.. method:: SetColour(self, *args, **kw)
Sets the currently selected colour.
See :meth:`wx.Colour.Set` .
|overload| Overloaded Implementations:
**~~~**
**SetColour** `(self, col)`
:param `col`:
:type `col`: wx.Colour
**~~~**
**SetColour** `(self, colname)`
:param `colname`:
:type `colname`: string
**~~~**
.. attribute:: Colour
See :meth:`~wx.ColourPickerCtrl.GetColour` and :meth:`~wx.ColourPickerCtrl.SetColour`