:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/ColorPickerButton.xml. .. _class_ColorPickerButton: ColorPickerButton ================= **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` A button that brings up a :ref:`ColorPicker` when pressed. .. rst-class:: classref-introduction-group Description ----------- Encapsulates a :ref:`ColorPicker`, making it accessible by pressing a button. Pressing the button will toggle the :ref:`ColorPicker`'s visibility. See also :ref:`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 :ref:`Control.custom_minimum_size` to a big enough value to give the button enough space. .. rst-class:: classref-introduction-group Tutorials --------- - `GUI Drag And Drop Demo `__ - `2D GD Paint Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`color` | ``Color(0, 0, 0, 1)`` | +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`edit_alpha` | ``true`` | +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | toggle_mode | ``true`` (overrides :ref:`BaseButton`) | +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+--------------------------------------------------------------------------+ | :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | +---------------------------------------+--------------------------------------------------------------------------+ | :ref:`PopupPanel` | :ref:`get_popup` **(** **)** | +---------------------------------------+--------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Color` | :ref:`font_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.9, 0.9, 0.9, 0.3)`` | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Color` | :ref:`font_focus_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Color` | :ref:`font_pressed_color` | ``Color(0.8, 0.8, 0.8, 1)`` | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`int` | :ref:`h_separation` | ``2`` | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Font` | :ref:`font` | | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`int` | :ref:`font_size` | | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`Texture2D` | :ref:`bg` | | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`StyleBox` | :ref:`disabled` | | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`StyleBox` | :ref:`focus` | | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`StyleBox` | :ref:`hover` | | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`StyleBox` | :ref:`normal` | | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ | :ref:`StyleBox` | :ref:`pressed` | | +-----------------------------------+-------------------------------------------------------------------------------------+-------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_ColorPickerButton_signal_color_changed: .. rst-class:: classref-signal **color_changed** **(** :ref:`Color` color **)** Emitted when the color changes. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_signal_picker_created: .. rst-class:: classref-signal **picker_created** **(** **)** Emitted when the :ref:`ColorPicker` is created (the button is pressed for the first time). .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_signal_popup_closed: .. rst-class:: classref-signal **popup_closed** **(** **)** Emitted when the :ref:`ColorPicker` is closed. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ColorPickerButton_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color(0, 0, 0, 1)`` .. rst-class:: classref-property-setget - void **set_pick_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_pick_color** **(** **)** The currently selected color. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_property_edit_alpha: .. rst-class:: classref-property :ref:`bool` **edit_alpha** = ``true`` .. rst-class:: classref-property-setget - void **set_edit_alpha** **(** :ref:`bool` value **)** - :ref:`bool` **is_editing_alpha** **(** **)** If ``true``, the alpha channel in the displayed :ref:`ColorPicker` will be visible. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ColorPickerButton_method_get_picker: .. rst-class:: classref-method :ref:`ColorPicker` **get_picker** **(** **)** Returns the :ref:`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 :ref:`CanvasItem.visible` property. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_method_get_popup: .. rst-class:: classref-method :ref:`PopupPanel` **get_popup** **(** **)** Returns the control's :ref:`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 :ref:`Window.visible` property. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_ColorPickerButton_theme_color_font_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_color** = ``Color(1, 1, 1, 1)`` Default text :ref:`Color` of the **ColorPickerButton**. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_color_font_disabled_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_disabled_color** = ``Color(0.9, 0.9, 0.9, 0.3)`` Text :ref:`Color` used when the **ColorPickerButton** is disabled. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_color_font_focus_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_focus_color** = ``Color(1, 1, 1, 1)`` Text :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_color_font_hover_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_hover_color** = ``Color(1, 1, 1, 1)`` Text :ref:`Color` used when the **ColorPickerButton** is being hovered. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_color_font_outline_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` The tint of text outline of the **ColorPickerButton**. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_color_font_pressed_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_pressed_color** = ``Color(0.8, 0.8, 0.8, 1)`` Text :ref:`Color` used when the **ColorPickerButton** is being pressed. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_constant_h_separation: .. rst-class:: classref-themeproperty :ref:`int` **h_separation** = ``2`` The horizontal space between **ColorPickerButton**'s icon and text. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_constant_outline_size: .. rst-class:: classref-themeproperty :ref:`int` **outline_size** = ``0`` The size of the text outline. \ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field` enabled, its :ref:`FontFile.msdf_pixel_range` must be set to at least *twice* the value of :ref:`outline_size` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_font_font: .. rst-class:: classref-themeproperty :ref:`Font` **font** :ref:`Font` of the **ColorPickerButton**'s text. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_font_size_font_size: .. rst-class:: classref-themeproperty :ref:`int` **font_size** Font size of the **ColorPickerButton**'s text. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_icon_bg: .. rst-class:: classref-themeproperty :ref:`Texture2D` **bg** The background of the color preview rect on the button. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_style_disabled: .. rst-class:: classref-themeproperty :ref:`StyleBox` **disabled** :ref:`StyleBox` used when the **ColorPickerButton** is disabled. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_style_focus: .. rst-class:: classref-themeproperty :ref:`StyleBox` **focus** :ref:`StyleBox` used when the **ColorPickerButton** is focused. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_style_hover: .. rst-class:: classref-themeproperty :ref:`StyleBox` **hover** :ref:`StyleBox` used when the **ColorPickerButton** is being hovered. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_style_normal: .. rst-class:: classref-themeproperty :ref:`StyleBox` **normal** Default :ref:`StyleBox` for the **ColorPickerButton**. .. rst-class:: classref-item-separator ---- .. _class_ColorPickerButton_theme_style_pressed: .. rst-class:: classref-themeproperty :ref:`StyleBox` **pressed** :ref:`StyleBox` used when the **ColorPickerButton** is being pressed. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`