ColorPickerButton

Inherits: Button < BaseButton < Control < CanvasItem < Node < Object

Button that pops out a ColorPicker.

Description

Encapsulates a ColorPicker making it accessible by pressing a button. Pressing the button will toggle the ColorPicker visibility.

See also BaseButton which contains common properties and methods associated with this node.

Note: By default, the button may not be wide enough for the color preview swatch to be visible. Make sure to set Control.custom_minimum_size to a big enough value to give the button enough space.

Tutorials

Properties

Color

color

Color(0, 0, 0, 1)

bool

edit_alpha

true

bool

toggle_mode

true (overrides BaseButton)

Methods

ColorPicker

get_picker ( )

PopupPanel

get_popup ( )

Theme Properties

Color

font_color

Color(1, 1, 1, 1)

Color

font_disabled_color

Color(0.9, 0.9, 0.9, 0.3)

Color

font_focus_color

Color(1, 1, 1, 1)

Color

font_hover_color

Color(1, 1, 1, 1)

Color

font_outline_color

Color(1, 1, 1, 1)

Color

font_pressed_color

Color(0.8, 0.8, 0.8, 1)

int

h_separation

2

int

outline_size

0

Font

font

int

font_size

Texture2D

bg

StyleBox

disabled

StyleBox

focus

StyleBox

hover

StyleBox

normal

StyleBox

pressed

Signals

  • color_changed ( Color color )

Emitted when the color changes.


  • picker_created ( )

Emitted when the ColorPicker is created (the button is pressed for the first time).


  • popup_closed ( )

Emitted when the ColorPicker is closed.

Property Descriptions

Default

Color(0, 0, 0, 1)

Setter

set_pick_color(value)

Getter

get_pick_color()

The currently selected color.


Default

true

Setter

set_edit_alpha(value)

Getter

is_editing_alpha()

If true, the alpha channel in the displayed ColorPicker will be visible.

Method Descriptions

Returns the ColorPicker that this node toggles.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.


Returns the control's PopupPanel which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their Window.visible property.

Theme Property Descriptions

Default

Color(1, 1, 1, 1)

Default text Color of the ColorPickerButton.


  • Color font_disabled_color

Default

Color(0.9, 0.9, 0.9, 0.3)

Text Color used when the ColorPickerButton is disabled.


Default

Color(1, 1, 1, 1)

Text Color used when the ColorPickerButton is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.


Default

Color(1, 1, 1, 1)

Text Color used when the ColorPickerButton is being hovered.


  • Color font_outline_color

Default

Color(1, 1, 1, 1)

The tint of text outline of the ColorPickerButton.


  • Color font_pressed_color

Default

Color(0.8, 0.8, 0.8, 1)

Text Color used when the ColorPickerButton is being pressed.


  • int h_separation

Default

2

The horizontal space between ColorPickerButton's icon and text.


  • int outline_size

Default

0

The size of the text outline.


Font of the ColorPickerButton's text.


  • int font_size

Font size of the ColorPickerButton's text.


The background of the color preview rect on the button.


StyleBox used when the ColorPickerButton is disabled.


StyleBox used when the ColorPickerButton is focused. The focus StyleBox is displayed over the base StyleBox, so a partially transparent StyleBox should be used to ensure the base StyleBox remains visible. A StyleBox that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a StyleBoxEmpty resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.


StyleBox used when the ColorPickerButton is being hovered.


Default StyleBox for the ColorPickerButton.


StyleBox used when the ColorPickerButton is being pressed.