mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
134 lines
4.9 KiB
ReStructuredText
134 lines
4.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the ColorPickerButton.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _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>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Button that pops out a :ref:`ColorPicker<class_ColorPicker>`.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------+----------------------------------------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`color<class_ColorPickerButton_property_color>` |
|
|
+---------------------------+----------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPickerButton_property_edit_alpha>` |
|
|
+---------------------------+----------------------------------------------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------------------+--------------------------------------------------------------------------+
|
|
| :ref:`ColorPicker<class_ColorPicker>` | :ref:`get_picker<class_ColorPickerButton_method_get_picker>` **(** **)** |
|
|
+---------------------------------------+--------------------------------------------------------------------------+
|
|
| :ref:`PopupPanel<class_PopupPanel>` | :ref:`get_popup<class_ColorPickerButton_method_get_popup>` **(** **)** |
|
|
+---------------------------------------+--------------------------------------------------------------------------+
|
|
|
|
Theme Properties
|
|
----------------
|
|
|
|
+---------------------------------+---------------------+
|
|
| :ref:`Texture<class_Texture>` | bg |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | disabled |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | focus |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`Font<class_Font>` | font |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`Color<class_Color>` | font_color |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`Color<class_Color>` | font_color_disabled |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`Color<class_Color>` | font_color_hover |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`Color<class_Color>` | font_color_pressed |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | hover |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`int<class_int>` | hseparation |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | normal |
|
|
+---------------------------------+---------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | pressed |
|
|
+---------------------------------+---------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_ColorPickerButton_signal_color_changed:
|
|
|
|
- **color_changed** **(** :ref:`Color<class_Color>` color **)**
|
|
|
|
Emitted when the color changes.
|
|
|
|
----
|
|
|
|
.. _class_ColorPickerButton_signal_popup_closed:
|
|
|
|
- **popup_closed** **(** **)**
|
|
|
|
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.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_ColorPickerButton_property_color:
|
|
|
|
- :ref:`Color<class_Color>` **color**
|
|
|
|
+----------+-----------------------+
|
|
| *Setter* | set_pick_color(value) |
|
|
+----------+-----------------------+
|
|
| *Getter* | get_pick_color() |
|
|
+----------+-----------------------+
|
|
|
|
The currently selected color.
|
|
|
|
----
|
|
|
|
.. _class_ColorPickerButton_property_edit_alpha:
|
|
|
|
- :ref:`bool<class_bool>` **edit_alpha**
|
|
|
|
+----------+-----------------------+
|
|
| *Setter* | set_edit_alpha(value) |
|
|
+----------+-----------------------+
|
|
| *Getter* | is_editing_alpha() |
|
|
+----------+-----------------------+
|
|
|
|
If ``true``, the alpha channel in the displayed :ref:`ColorPicker<class_ColorPicker>` will be visible. Default value: ``true``.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_ColorPickerButton_method_get_picker:
|
|
|
|
- :ref:`ColorPicker<class_ColorPicker>` **get_picker** **(** **)**
|
|
|
|
Returns the :ref:`ColorPicker<class_ColorPicker>` that this node toggles.
|
|
|
|
----
|
|
|
|
.. _class_ColorPickerButton_method_get_popup:
|
|
|
|
- :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.
|
|
|