class_colorpickerbutton.rst 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_ColorPickerButton:
  4. ColorPickerButton
  5. =================
  6. **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>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Button that pops out a :ref:`ColorPicker<class_colorpicker>`
  11. Member Functions
  12. ----------------
  13. +----------------------------+----------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`set_color<class_ColorPickerButton_set_color>` **(** :ref:`Color<class_color>` color **)** |
  15. +----------------------------+----------------------------------------------------------------------------------------------------------+
  16. | :ref:`Color<class_color>` | :ref:`get_color<class_ColorPickerButton_get_color>` **(** **)** const |
  17. +----------------------------+----------------------------------------------------------------------------------------------------------+
  18. | void | :ref:`set_edit_alpha<class_ColorPickerButton_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
  19. +----------------------------+----------------------------------------------------------------------------------------------------------+
  20. | :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPickerButton_is_editing_alpha>` **(** **)** const |
  21. +----------------------------+----------------------------------------------------------------------------------------------------------+
  22. Signals
  23. -------
  24. - **color_changed** **(** :ref:`Color<class_color>` color **)**
  25. Description
  26. -----------
  27. Encapsulates a :ref:`ColorPicker<class_colorpicker>` making it accesible by pressing a button, pressing the button will toggle the :ref:`ColorPicker<class_colorpicker>` visibility
  28. Member Function Description
  29. ---------------------------
  30. .. _class_ColorPickerButton_set_color:
  31. - void **set_color** **(** :ref:`Color<class_color>` color **)**
  32. Sets the current color
  33. .. _class_ColorPickerButton_get_color:
  34. - :ref:`Color<class_color>` **get_color** **(** **)** const
  35. Gets the current color
  36. .. _class_ColorPickerButton_set_edit_alpha:
  37. - void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
  38. See :ref:`ColorPicker.set_edit_alpha<class_ColorPicker_set_edit_alpha>`
  39. .. _class_ColorPickerButton_is_editing_alpha:
  40. - :ref:`bool<class_bool>` **is_editing_alpha** **(** **)** const
  41. See :ref:`ColorPicker.is_edit_alpha<class_ColorPicker_is_edit_alpha>`