2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "ColorPickerButton" inherits= "Button" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2018-03-31 07:11:14 +08:00
Button that pops out a [ColorPicker].
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2018-09-13 09:38:39 +08:00
Encapsulates a [ColorPicker] making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility.
2020-09-24 05:34:28 +08:00
See also [BaseButton] which contains common properties and methods associated with this node.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
2020-10-01 16:34:47 +08: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-13 04:42:36 +08:00
</tutorials>
<methods >
2018-05-28 20:53:15 +08:00
<method name= "get_picker" >
2017-09-13 04:42:36 +08:00
<return type= "ColorPicker" >
</return>
<description >
2018-08-18 05:55:19 +08:00
Returns the [ColorPicker] that this node toggles.
2017-09-13 04:42:36 +08:00
</description>
</method>
2018-07-26 17:56:21 +08:00
<method name= "get_popup" >
2017-12-02 04:58:53 +08:00
<return type= "PopupPanel" >
</return>
<description >
2018-08-18 05:55:19 +08: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.
2017-12-02 04:58:53 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
</methods>
<members >
2019-06-29 18:38:01 +08:00
<member name= "color" type= "Color" setter= "set_pick_color" getter= "get_pick_color" default= "Color( 0, 0, 0, 1 )" >
2017-12-05 02:57:59 +08:00
The currently selected color.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "edit_alpha" type= "bool" setter= "set_edit_alpha" getter= "is_editing_alpha" default= "true" >
2019-06-29 21:24:23 +08:00
If [code]true[/code], the alpha channel in the displayed [ColorPicker] will be visible.
2017-09-13 04:42:36 +08:00
</member>
2019-09-24 19:34:03 +08:00
<member name= "toggle_mode" type= "bool" setter= "set_toggle_mode" getter= "is_toggle_mode" override= "true" default= "true" />
2017-09-13 04:42:36 +08:00
</members>
<signals >
<signal name= "color_changed" >
<argument index= "0" name= "color" type= "Color" >
</argument>
<description >
2017-12-05 02:57:59 +08:00
Emitted when the color changes.
2017-09-13 04:42:36 +08:00
</description>
</signal>
2019-09-24 17:44:48 +08:00
<signal name= "picker_created" >
<description >
2020-01-14 06:08:42 +08:00
Emitted when the [ColorPicker] is created (the button is pressed for the first time).
2019-09-24 17:44:48 +08:00
</description>
</signal>
2018-05-12 15:38:00 +08:00
<signal name= "popup_closed" >
<description >
2020-01-14 06:08:42 +08:00
Emitted when the [ColorPicker] is closed.
2018-05-12 15:38:00 +08:00
</description>
</signal>
2017-09-13 04:42:36 +08:00
</signals>
<constants >
</constants>
<theme_items >
2020-02-12 16:59:06 +08:00
<theme_item name= "bg" type= "Texture2D" >
2020-02-04 15:46:01 +08:00
The background of the color preview rect on the button.
2017-10-12 05:54:43 +08:00
</theme_item>
2017-09-13 04:42:36 +08:00
<theme_item name= "disabled" type= "StyleBox" >
2020-02-04 15:46:01 +08:00
[StyleBox] used when the [ColorPickerButton] is disabled.
2017-09-13 04:42:36 +08:00
</theme_item>
<theme_item name= "focus" type= "StyleBox" >
2020-02-04 15:46:01 +08:00
[StyleBox] used when the [ColorPickerButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
2017-09-13 04:42:36 +08:00
</theme_item>
<theme_item name= "font" type= "Font" >
2020-02-04 15:46:01 +08:00
[Font] of the [ColorPickerButton]'s text.
2017-09-13 04:42:36 +08:00
</theme_item>
2019-06-29 18:38:01 +08:00
<theme_item name= "font_color" type= "Color" default= "Color( 1, 1, 1, 1 )" >
2020-02-04 15:46:01 +08:00
Default text [Color] of the [ColorPickerButton].
2017-09-13 04:42:36 +08:00
</theme_item>
2019-06-29 18:38:01 +08:00
<theme_item name= "font_color_disabled" type= "Color" default= "Color( 0.9, 0.9, 0.9, 0.3 )" >
2020-02-04 15:46:01 +08:00
Text [Color] used when the [ColorPickerButton] is disabled.
2017-09-13 04:42:36 +08:00
</theme_item>
2019-06-29 18:38:01 +08:00
<theme_item name= "font_color_hover" type= "Color" default= "Color( 1, 1, 1, 1 )" >
2020-02-04 15:46:01 +08:00
Text [Color] used when the [ColorPickerButton] is being hovered.
2017-09-13 04:42:36 +08:00
</theme_item>
2019-06-29 18:38:01 +08:00
<theme_item name= "font_color_pressed" type= "Color" default= "Color( 0.8, 0.8, 0.8, 1 )" >
2020-02-04 15:46:01 +08:00
Text [Color] used when the [ColorPickerButton] is being pressed.
2017-09-13 04:42:36 +08:00
</theme_item>
2020-08-12 19:49:10 +08:00
<theme_item name= "font_size" type= "int" >
Font size of the [ColorPickerButton]'s text.
</theme_item>
2017-09-13 04:42:36 +08:00
<theme_item name= "hover" type= "StyleBox" >
2020-02-04 15:46:01 +08:00
[StyleBox] used when the [ColorPickerButton] is being hovered.
2017-09-13 04:42:36 +08:00
</theme_item>
2019-06-29 18:38:01 +08:00
<theme_item name= "hseparation" type= "int" default= "2" >
2020-02-04 15:46:01 +08:00
The horizontal space between [ColorPickerButton]'s icon and text.
2017-09-13 04:42:36 +08:00
</theme_item>
<theme_item name= "normal" type= "StyleBox" >
2020-02-04 15:46:01 +08:00
Default [StyleBox] for the [ColorPickerButton].
2017-09-13 04:42:36 +08:00
</theme_item>
<theme_item name= "pressed" type= "StyleBox" >
2020-02-04 15:46:01 +08:00
[StyleBox] used when the [ColorPickerButton] is being pressed.
2017-09-13 04:42:36 +08:00
</theme_item>
</theme_items>
</class>