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.rect_min_size to a big enough value to give the button enough space.
Tutorials
Properties
| ||
| ||
toggle_mode |
|
Methods
get_picker ( ) | |
get_popup ( ) |
Theme Properties
| ||
| ||
| ||
| ||
| ||
| ||
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 |
|
Setter | set_pick_color(value) |
Getter | get_pick_color() |
The currently selected color.
- bool edit_alpha
Default |
|
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.
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.
- 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.
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.
Theme Property Descriptions
- Texture bg
The background of the color preview rect on the button.
- StyleBox disabled
StyleBox used when the ColorPickerButton
is disabled.
- StyleBox focus
StyleBox used when the ColorPickerButton
is focused. It is displayed over the current StyleBox, so using StyleBoxEmpty will just disable the focus visual effect.
- Font font
Font of the ColorPickerButton
‘s text.
- Color font_color
Default |
|
Default text Color of the ColorPickerButton
.
- Color font_color_disabled
Default |
|
Text Color used when the ColorPickerButton
is disabled.
- Color font_color_focus
Default |
|
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.
- Color font_color_hover
Default |
|
Text Color used when the ColorPickerButton
is being hovered.
- Color font_color_pressed
Default |
|
Text Color used when the ColorPickerButton
is being pressed.
- StyleBox hover
StyleBox used when the ColorPickerButton
is being hovered.
- int hseparation
Default |
|
The horizontal space between ColorPickerButton
‘s icon and text.
- StyleBox normal
Default StyleBox for the ColorPickerButton
.
- StyleBox pressed
StyleBox used when the ColorPickerButton
is being pressed.