class_colorpickerbutton.rst 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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. | :ref:`Color<class_color>` | :ref:`get_pick_color<class_ColorPickerButton_get_pick_color>` **(** **)** const |
  15. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  16. | :ref:`ColorPicker<class_colorpicker>` | :ref:`get_picker<class_ColorPickerButton_get_picker>` **(** **)** |
  17. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPickerButton_is_editing_alpha>` **(** **)** const |
  19. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`set_edit_alpha<class_ColorPickerButton_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
  21. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_pick_color<class_ColorPickerButton_set_pick_color>` **(** :ref:`Color<class_color>` color **)** |
  23. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  24. Signals
  25. -------
  26. - **color_changed** **(** :ref:`Color<class_color>` color **)**
  27. Member Variables
  28. ----------------
  29. - :ref:`Color<class_color>` **color**
  30. - :ref:`bool<class_bool>` **edit_alpha**
  31. Description
  32. -----------
  33. Encapsulates a :ref:`ColorPicker<class_colorpicker>` making it accesible by pressing a button, pressing the button will toggle the :ref:`ColorPicker<class_colorpicker>` visibility
  34. Member Function Description
  35. ---------------------------
  36. .. _class_ColorPickerButton_get_pick_color:
  37. - :ref:`Color<class_color>` **get_pick_color** **(** **)** const
  38. .. _class_ColorPickerButton_get_picker:
  39. - :ref:`ColorPicker<class_colorpicker>` **get_picker** **(** **)**
  40. .. _class_ColorPickerButton_is_editing_alpha:
  41. - :ref:`bool<class_bool>` **is_editing_alpha** **(** **)** const
  42. See :ref:`ColorPicker.is_edit_alpha<class_ColorPicker_is_edit_alpha>`
  43. .. _class_ColorPickerButton_set_edit_alpha:
  44. - void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
  45. See :ref:`ColorPicker.set_edit_alpha<class_ColorPicker_set_edit_alpha>`
  46. .. _class_ColorPickerButton_set_pick_color:
  47. - void **set_pick_color** **(** :ref:`Color<class_color>` color **)**