wx.ColourPickerCtrl

Inheritance diagram for wx.ColourPickerCtrl:



Description

This control allows the user to select a colour. The generic implementation is a button which brings up a 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 wx.USE_COLOURPICKERCTRL is set to 1 (the default).

Window Styles

Window Style Description
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 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.
wx.CLRP_SHOW_LABEL Shows the colour in HTML form (AABBCC) as colour button label (instead of no label at all).

Event Handling

Event Name Description
wx.EVT_COLOURPICKER_CHANGED(id, func) The user changed the colour selected in the control either using the button or using text control (see wx.CLRP_USE_TEXTCTRL; note that in this case the event is fired only if the user’s input is valid, i.e. recognizable).

Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


Methods Summary

Properties Summary

Class API

Methods

__init__(parent, id=-1, col=wx.BLACK, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.CLRP_DEFAULT_STYLE, validator=wx.DefaultValidator, name=wx.ColourPickerCtrlNameStr)

This control allows the user to select a colour. The generic implementation is a button which brings up a wx.ColourDialog when clicked. Native implementations may differ but this is usually a (small) widget which give access to the colour-chooser dialog.

Parameters:


Returns:

wx.ColourPickerCtrl


GetColour()

Returns the currently selected colour.


Returns:

wx.Colour


SetColour(col)

Sets the currently selected colour.

Parameters:

See also

wx.Colour.Set


Properties

Colour
See GetColour and SetColour