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.

Properties

Color color Color( 0, 0, 0, 1 )
bool edit_alpha true
bool toggle_mode true (parent override)

Methods

ColorPicker get_picker ( )
PopupPanel get_popup ( )

Theme Properties

Texture bg
StyleBox disabled
StyleBox focus
Font font
Color font_color Color( 1, 1, 1, 1 )
Color font_color_disabled Color( 0.9, 0.9, 0.9, 0.3 )
Color font_color_hover Color( 1, 1, 1, 1 )
Color font_color_pressed Color( 0.8, 0.8, 0.8, 1 )
StyleBox hover
int hseparation 2
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

Color color

Default Color( 0, 0, 0, 1 )
Setter set_pick_color(value)
Getter get_pick_color()

The currently selected color.

bool edit_alpha

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

ColorPicker get_picker ( )

Returns the ColorPicker that this node toggles.

PopupPanel get_popup ( )

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.

© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.2/classes/class_colorpickerbutton.html