2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name= "ColorPickerButton" inherits= "Button" version= "4.0" >
2017-09-12 20:42:36 +00:00
<brief_description >
2018-03-30 23:11:14 +00:00
Button that pops out a [ColorPicker].
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2018-09-13 01:38:39 +00:00
Encapsulates a [ColorPicker] making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility.
2020-09-23 21:34:28 +00:00
See also [BaseButton] which contains common properties and methods associated with this node.
2021-09-24 23:21:31 +00:00
[b]Note:[/b] By default, the button may not be wide enough for the color preview swatch to be visible. Make sure to set [member Control.rect_min_size] to a big enough value to give the button enough space.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2020-10-01 08:34:47 +00:00
<link title= "GUI Drag And Drop Demo" > https://godotengine.org/asset-library/asset/133</link>
<link title= "2D GD Paint Demo" > https://godotengine.org/asset-library/asset/517</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<methods >
2018-05-28 12:53:15 +00:00
<method name= "get_picker" >
2021-07-30 13:28:05 +00:00
<return type= "ColorPicker" />
2017-09-12 20:42:36 +00:00
<description >
2018-08-17 21:55:19 +00:00
Returns the [ColorPicker] that this node toggles.
2021-10-10 19:28:56 +00:00
[b]Warning:[/b] 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 [member CanvasItem.visible] property.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-07-26 09:56:21 +00:00
<method name= "get_popup" >
2021-07-30 13:28:05 +00:00
<return type= "PopupPanel" />
2017-12-01 20:58:53 +00:00
<description >
2018-08-17 21:55:19 +00:00
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.
2021-10-10 19:28:56 +00:00
[b]Warning:[/b] 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 [member Window.visible] property.
2017-12-01 20:58:53 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
</methods>
<members >
2019-09-24 17:45:03 +00:00
<member name= "color" type= "Color" setter= "set_pick_color" getter= "get_pick_color" default= "Color(0, 0, 0, 1)" >
2017-12-04 18:57:59 +00:00
The currently selected color.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "edit_alpha" type= "bool" setter= "set_edit_alpha" getter= "is_editing_alpha" default= "true" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], the alpha channel in the displayed [ColorPicker] will be visible.
2017-09-12 20:42:36 +00:00
</member>
2019-09-24 11:34:03 +00:00
<member name= "toggle_mode" type= "bool" setter= "set_toggle_mode" getter= "is_toggle_mode" override= "true" default= "true" />
2017-09-12 20:42:36 +00:00
</members>
<signals >
<signal name= "color_changed" >
2021-07-30 13:28:05 +00:00
<argument index= "0" name= "color" type= "Color" />
2017-09-12 20:42:36 +00:00
<description >
2017-12-04 18:57:59 +00:00
Emitted when the color changes.
2017-09-12 20:42:36 +00:00
</description>
</signal>
2019-09-24 09:44:48 +00:00
<signal name= "picker_created" >
<description >
2020-01-13 22:08:42 +00:00
Emitted when the [ColorPicker] is created (the button is pressed for the first time).
2019-09-24 09:44:48 +00:00
</description>
</signal>
2018-05-12 07:38:00 +00:00
<signal name= "popup_closed" >
<description >
2020-01-13 22:08:42 +00:00
Emitted when the [ColorPicker] is closed.
2018-05-12 07:38:00 +00:00
</description>
</signal>
2017-09-12 20:42:36 +00:00
</signals>
<theme_items >
2021-08-04 16:54:41 +00:00
<theme_item name= "font_color" data_type= "color" type= "Color" default= "Color(1, 1, 1, 1)" >
2020-02-04 07:46:01 +00:00
Default text [Color] of the [ColorPickerButton].
2017-09-12 20:42:36 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "font_disabled_color" data_type= "color" type= "Color" default= "Color(0.9, 0.9, 0.9, 0.3)" >
2020-02-04 07:46:01 +00:00
Text [Color] used when the [ColorPickerButton] is disabled.
2017-09-12 20:42:36 +00:00
</theme_item>
2021-10-26 14:28:12 +00:00
<theme_item name= "font_focus_color" data_type= "color" type= "Color" 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.
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "font_hover_color" data_type= "color" type= "Color" default= "Color(1, 1, 1, 1)" >
2020-02-04 07:46:01 +00:00
Text [Color] used when the [ColorPickerButton] is being hovered.
2017-09-12 20:42:36 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "font_outline_color" data_type= "color" type= "Color" default= "Color(1, 1, 1, 1)" >
2020-12-25 21:45:28 +00:00
The tint of text outline of the [ColorPickerButton].
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "font_pressed_color" data_type= "color" type= "Color" default= "Color(0.8, 0.8, 0.8, 1)" >
2020-02-04 07:46:01 +00:00
Text [Color] used when the [ColorPickerButton] is being pressed.
2017-09-12 20:42:36 +00:00
</theme_item>
2021-12-01 18:02:20 +00:00
<theme_item name= "hseparation" data_type= "constant" type= "int" default= "2" >
The horizontal space between [ColorPickerButton]'s icon and text.
</theme_item>
<theme_item name= "outline_size" data_type= "constant" type= "int" default= "0" >
The size of the text outline.
</theme_item>
<theme_item name= "font" data_type= "font" type= "Font" >
[Font] of the [ColorPickerButton]'s text.
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "font_size" data_type= "font_size" type= "int" >
2020-08-12 11:49:10 +00:00
Font size of the [ColorPickerButton]'s text.
</theme_item>
2021-12-01 18:02:20 +00:00
<theme_item name= "bg" data_type= "icon" type= "Texture2D" >
The background of the color preview rect on the button.
</theme_item>
<theme_item name= "disabled" data_type= "style" type= "StyleBox" >
[StyleBox] used when the [ColorPickerButton] is disabled.
</theme_item>
<theme_item name= "focus" data_type= "style" type= "StyleBox" >
[StyleBox] used when the [ColorPickerButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "hover" data_type= "style" type= "StyleBox" >
2020-02-04 07:46:01 +00:00
[StyleBox] used when the [ColorPickerButton] is being hovered.
2017-09-12 20:42:36 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "normal" data_type= "style" type= "StyleBox" >
2020-02-04 07:46:01 +00:00
Default [StyleBox] for the [ColorPickerButton].
2017-09-12 20:42:36 +00:00
</theme_item>
2021-08-04 16:54:41 +00:00
<theme_item name= "pressed" data_type= "style" type= "StyleBox" >
2020-02-04 07:46:01 +00:00
[StyleBox] used when the [ColorPickerButton] is being pressed.
2017-09-12 20:42:36 +00:00
</theme_item>
</theme_items>
</class>