phoenix_title wx.ColourPickerCtrl

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 USE_COLOURPICKERCTRL is set to 1 (the default).

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

  • wx.CLRP_SHOW_ALPHA: Allows selecting opacity in the colour-chooser (effective under wxGTK and wxOSX).

events Events Emitted by this Class

Handlers bound for the following event types will receive a 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). When using a popup dialog for changing the colour, this event is sent only when the changes in the dialog are accepted by the user, unlike EVT_COLOURPICKER_CURRENT_CHANGED .

  • EVT_COLOURPICKER_CURRENT_CHANGED: The user changed the currently selected colour in the dialog associated with the control. This event is sent immediately when the selection changes and you must also handle EVT_COLOUR_CANCELLED to revert to the previously selected colour if the selection ends up not being accepted. This event is new since wxWidgets 3.1.3 and currently is only implemented in wxMSW.

  • EVT_COLOURPICKER_DIALOG_CANCELLED: The user cancelled the colour dialog associated with the control, i.e. closed it without accepting the selection. This event is new since wxWidgets 3.1.3 and currently is only implemented in wxMSW.


class_hierarchy Class Hierarchy

Inheritance diagram for class ColourPickerCtrl:

appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__

Create

Creates a colour picker with the given arguments.

GetClassDefaultAttributes

GetColour

Returns the currently selected colour.

SetColour

Sets the currently selected colour.


property_summary Properties Summary

Colour

See GetColour and 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.


Methods

__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 Create with all the parameters.

Parameters





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.

Parameters
  • parent (wx.Window) – Parent window, must not be not None.

  • id (wx.WindowID) – The identifier for the control.

  • colour (wx.Colour) – The initial colour shown in the control.

  • pos (wx.Point) – Initial position.

  • size (wx.Size) – Initial size.

  • style (long) – The window style, see CRLP_ flags.

  • validator (wx.Validator) – Validator which can be used for additional date checks.

  • name (string) – Control name.

Return type

bool

Returns

True if the control was successfully created or False if creation failed.



static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters

variant (WindowVariant) –

Return type

wx.VisualAttributes



GetColour(self)

Returns the currently selected colour.

Return type

wx.Colour



SetColour(self, *args, **kw)

Sets the currently selected colour.

See wx.Colour.Set .

overload Overloaded Implementations:



SetColour (self, col)

Parameters

col (wx.Colour) –



SetColour (self, colname)

Parameters

colname (string) –




Properties

Colour

See GetColour and SetColour