godot-docs/classes/class_colorpickerbutton.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ColorPickerButton.xml.

.. _class_ColorPickerButton:

ColorPickerButton
=================

**Inherits:** :ref:`Button<class_Button>` **<** :ref:`BaseButton<class_BaseButton>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

Button that pops out a :ref:`ColorPicker<class_ColorPicker>`.

.. rst-class:: classref-introduction-group

Description
-----------

Encapsulates a :ref:`ColorPicker<class_ColorPicker>` making it accessible by pressing a button. Pressing the button will toggle the :ref:`ColorPicker<class_ColorPicker>` visibility.

See also :ref:`BaseButton<class_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.rect_min_size<class_Control_property_rect_min_size>` to a big enough value to give the button enough space.

.. rst-class:: classref-introduction-group

Tutorials
---------

- `GUI Drag And Drop Demo <https://godotengine.org/asset-library/asset/133>`__

- `2D GD Paint Demo <https://godotengine.org/asset-library/asset/517>`__

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>` | :ref:`color<class_ColorPickerButton_property_color>`           | ``Color( 0, 0, 0, 1 )``                                                       |
   +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`   | :ref:`edit_alpha<class_ColorPickerButton_property_edit_alpha>` | ``true``                                                                      |
   +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`   | toggle_mode                                                    | ``true`` (overrides :ref:`BaseButton<class_BaseButton_property_toggle_mode>`) |
   +---------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +---------------------------------------+--------------------------------------------------------------------------+
   | :ref:`ColorPicker<class_ColorPicker>` | :ref:`get_picker<class_ColorPickerButton_method_get_picker>` **(** **)** |
   +---------------------------------------+--------------------------------------------------------------------------+
   | :ref:`PopupPanel<class_PopupPanel>`   | :ref:`get_popup<class_ColorPickerButton_method_get_popup>` **(** **)**   |
   +---------------------------------------+--------------------------------------------------------------------------+

.. rst-class:: classref-reftable-group

Theme Properties
----------------

.. table::
   :widths: auto

   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color<class_ColorPickerButton_theme_color_font_color>`                   | ``Color( 1, 1, 1, 1 )``         |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color_disabled<class_ColorPickerButton_theme_color_font_color_disabled>` | ``Color( 0.9, 0.9, 0.9, 0.3 )`` |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color_focus<class_ColorPickerButton_theme_color_font_color_focus>`       | ``Color( 1, 1, 1, 1 )``         |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color_hover<class_ColorPickerButton_theme_color_font_color_hover>`       | ``Color( 1, 1, 1, 1 )``         |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color_pressed<class_ColorPickerButton_theme_color_font_color_pressed>`   | ``Color( 0.8, 0.8, 0.8, 1 )``   |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`int<class_int>`           | :ref:`hseparation<class_ColorPickerButton_theme_constant_hseparation>`              | ``2``                           |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`Font<class_Font>`         | :ref:`font<class_ColorPickerButton_theme_font_font>`                                |                                 |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`bg<class_ColorPickerButton_theme_icon_bg>`                                    |                                 |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_ColorPickerButton_theme_style_disabled>`                       |                                 |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_ColorPickerButton_theme_style_focus>`                             |                                 |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_ColorPickerButton_theme_style_hover>`                             |                                 |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_ColorPickerButton_theme_style_normal>`                           |                                 |
   +---------------------------------+-------------------------------------------------------------------------------------+---------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_ColorPickerButton_theme_style_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<class_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<class_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<class_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<class_Color>` **color** = ``Color( 0, 0, 0, 1 )``

.. rst-class:: classref-property-setget

- void **set_pick_color** **(** :ref:`Color<class_Color>` value **)**
- :ref:`Color<class_Color>` **get_pick_color** **(** **)**

The currently selected color.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_property_edit_alpha:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **edit_alpha** = ``true``

.. rst-class:: classref-property-setget

- void **set_edit_alpha** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_editing_alpha** **(** **)**

If ``true``, the alpha channel in the displayed :ref:`ColorPicker<class_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<class_ColorPicker>` **get_picker** **(** **)**

Returns the :ref:`ColorPicker<class_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<class_CanvasItem_property_visible>` property.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_method_get_popup:

.. rst-class:: classref-method

:ref:`PopupPanel<class_PopupPanel>` **get_popup** **(** **)**

Returns the control's :ref:`PopupPanel<class_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:`CanvasItem.visible<class_CanvasItem_property_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<class_Color>` **font_color** = ``Color( 1, 1, 1, 1 )``

Default text :ref:`Color<class_Color>` of the **ColorPickerButton**.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_theme_color_font_color_disabled:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color_disabled** = ``Color( 0.9, 0.9, 0.9, 0.3 )``

Text :ref:`Color<class_Color>` used when the **ColorPickerButton** is disabled.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_theme_color_font_color_focus:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color_focus** = ``Color( 1, 1, 1, 1 )``

Text :ref:`Color<class_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_color_hover:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color_hover** = ``Color( 1, 1, 1, 1 )``

Text :ref:`Color<class_Color>` used when the **ColorPickerButton** is being hovered.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_theme_color_font_color_pressed:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color_pressed** = ``Color( 0.8, 0.8, 0.8, 1 )``

Text :ref:`Color<class_Color>` used when the **ColorPickerButton** is being pressed.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_theme_constant_hseparation:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **hseparation** = ``2``

The horizontal space between **ColorPickerButton**'s icon and text.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_theme_font_font:

.. rst-class:: classref-themeproperty

:ref:`Font<class_Font>` **font**

:ref:`Font<class_Font>` of the **ColorPickerButton**'s text.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_theme_icon_bg:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **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<class_StyleBox>` **disabled**

:ref:`StyleBox<class_StyleBox>` used when the **ColorPickerButton** is disabled.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_theme_style_focus:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **focus**

:ref:`StyleBox<class_StyleBox>` used when the **ColorPickerButton** is focused. It is displayed over the current :ref:`StyleBox<class_StyleBox>`, so using :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` will just disable the focus visual effect.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_theme_style_hover:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **hover**

:ref:`StyleBox<class_StyleBox>` used when the **ColorPickerButton** is being hovered.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_theme_style_normal:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **normal**

Default :ref:`StyleBox<class_StyleBox>` for the **ColorPickerButton**.

.. rst-class:: classref-item-separator

----

.. _class_ColorPickerButton_theme_style_pressed:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **pressed**

:ref:`StyleBox<class_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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`