2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 13:40:43 +01:00
<class name= "ColorPicker" inherits= "BoxContainer" category= "Core" version= "3.1" >
2017-09-12 22:42:36 +02:00
<brief_description >
Color picker control.
</brief_description>
<description >
2018-08-17 23:55:19 +02:00
[Control] node displaying a color picker widget. It's useful for selecting a color from an RGB/RGBA colorspace.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_preset" >
<return type= "void" >
</return>
<argument index= "0" name= "color" type= "Color" >
</argument>
<description >
2018-08-17 23:55:19 +02:00
Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for [i]this[/i] color picker.
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-10-03 16:12:38 +02:00
<method name= "erase_preset" >
<return type= "void" >
</return>
<argument index= "0" name= "color" type= "Color" >
</argument>
<description >
Remove the given color from the list of color presets of this color picker.
</description>
</method>
2018-12-13 15:12:25 +01:00
<method name= "get_presets" qualifiers= "const" >
2018-10-03 16:12:38 +02:00
<return type= "PoolColorArray" >
</return>
<description >
Return the list of colors in the presets of the color picker.
</description>
</method>
2017-09-12 22:42:36 +02:00
</methods>
2018-01-11 23:38:35 +01:00
<members >
<member name= "color" type= "Color" setter= "set_pick_color" getter= "get_pick_color" >
The currently selected color.
</member>
2018-07-26 11:56:21 +02:00
<member name= "deferred_mode" type= "bool" setter= "set_deferred_mode" getter= "is_deferred_mode" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues).
2018-07-26 11:56:21 +02:00
</member>
2018-01-11 23:38:35 +01:00
<member name= "edit_alpha" type= "bool" setter= "set_edit_alpha" getter= "is_editing_alpha" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], shows an alpha channel slider (transparency).
2018-01-11 23:38:35 +01:00
</member>
<member name= "raw_mode" type= "bool" setter= "set_raw_mode" getter= "is_raw_mode" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
2018-01-11 23:38:35 +01:00
</member>
</members>
2017-09-12 22:42:36 +02:00
<signals >
<signal name= "color_changed" >
<argument index= "0" name= "color" type= "Color" >
</argument>
<description >
Emitted when the color is changed.
</description>
</signal>
2018-10-03 16:12:38 +02:00
<signal name= "preset_added" >
<argument index= "0" name= "color" type= "Color" >
</argument>
<description >
Emitted when a preset is added.
</description>
</signal>
<signal name= "preset_removed" >
<argument index= "0" name= "color" type= "Color" >
</argument>
<description >
Emitted when a preset is removed.
</description>
</signal>
</signals>
2017-09-12 22:42:36 +02:00
<constants >
</constants>
<theme_items >
<theme_item name= "add_preset" type= "Texture" >
</theme_item>
<theme_item name= "color_hue" type= "Texture" >
</theme_item>
<theme_item name= "color_sample" type= "Texture" >
</theme_item>
<theme_item name= "h_width" type= "int" >
</theme_item>
<theme_item name= "label_width" type= "int" >
</theme_item>
<theme_item name= "margin" type= "int" >
</theme_item>
2017-10-11 23:54:43 +02:00
<theme_item name= "preset_bg" type= "Texture" >
</theme_item>
2017-09-12 22:42:36 +02:00
<theme_item name= "screen_picker" type= "Texture" >
</theme_item>
<theme_item name= "sv_height" type= "int" >
</theme_item>
<theme_item name= "sv_width" type= "int" >
</theme_item>
</theme_items>
</class>