| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147 |
- :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>`
- Button that pops out a :ref:`ColorPicker<class_ColorPicker>`.
- 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.
- Properties
- ----------
- +---------------------------+----------------------------------------------------------------+------------------------------+
- | :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`` *(parent override)* |
- +---------------------------+----------------------------------------------------------------+------------------------------+
- 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 | Color( 1, 1, 1, 1 ) |
- +---------------------------------+---------------------+-----------------------------+
- | :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.3 ) |
- +---------------------------------+---------------------+-----------------------------+
- | :ref:`Color<class_Color>` | font_color_hover | Color( 1, 1, 1, 1 ) |
- +---------------------------------+---------------------+-----------------------------+
- | :ref:`Color<class_Color>` | font_color_pressed | Color( 0.8, 0.8, 0.8, 1 ) |
- +---------------------------------+---------------------+-----------------------------+
- | :ref:`StyleBox<class_StyleBox>` | hover | |
- +---------------------------------+---------------------+-----------------------------+
- | :ref:`int<class_int>` | hseparation | 2 |
- +---------------------------------+---------------------+-----------------------------+
- | :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_picker_created:
- - **picker_created** **(** **)**
- Emitted when the :ref:`ColorPicker<class_ColorPicker>` is created (the button is pressed for the first time).
- ----
- .. _class_ColorPickerButton_signal_popup_closed:
- - **popup_closed** **(** **)**
- Emitted when the :ref:`ColorPicker<class_ColorPicker>` is closed.
- Property Descriptions
- ---------------------
- .. _class_ColorPickerButton_property_color:
- - :ref:`Color<class_Color>` **color**
- +-----------+-------------------------+
- | *Default* | ``Color( 0, 0, 0, 1 )`` |
- +-----------+-------------------------+
- | *Setter* | set_pick_color(value) |
- +-----------+-------------------------+
- | *Getter* | get_pick_color() |
- +-----------+-------------------------+
- The currently selected color.
- ----
- .. _class_ColorPickerButton_property_edit_alpha:
- - :ref:`bool<class_bool>` **edit_alpha**
- +-----------+-----------------------+
- | *Default* | ``true`` |
- +-----------+-----------------------+
- | *Setter* | set_edit_alpha(value) |
- +-----------+-----------------------+
- | *Getter* | is_editing_alpha() |
- +-----------+-----------------------+
- If ``true``, the alpha channel in the displayed :ref:`ColorPicker<class_ColorPicker>` will be visible.
- 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.
- .. |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.)`
|
