class_colorpickerbutton.rst 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the ColorPickerButton.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_ColorPickerButton:
  5. ColorPickerButton
  6. =================
  7. **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>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Button that pops out a :ref:`ColorPicker<class_colorpicker>`
  12. Member Functions
  13. ----------------
  14. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  15. | :ref:`Color<class_color>` | :ref:`get_pick_color<class_ColorPickerButton_get_pick_color>` **(** **)** const |
  16. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  17. | :ref:`ColorPicker<class_colorpicker>` | :ref:`get_picker<class_ColorPickerButton_get_picker>` **(** **)** |
  18. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPickerButton_is_editing_alpha>` **(** **)** const |
  20. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_edit_alpha<class_ColorPickerButton_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
  22. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`set_pick_color<class_ColorPickerButton_set_pick_color>` **(** :ref:`Color<class_color>` color **)** |
  24. +----------------------------------------+-------------------------------------------------------------------------------------------------------------+
  25. Signals
  26. -------
  27. - **color_changed** **(** :ref:`Color<class_color>` color **)**
  28. Emitted when the color is changed.
  29. Member Variables
  30. ----------------
  31. - :ref:`Color<class_color>` **color**
  32. - :ref:`bool<class_bool>` **edit_alpha**
  33. Description
  34. -----------
  35. Encapsulates a :ref:`ColorPicker<class_colorpicker>` making it accesible by pressing a button, pressing the button will toggle the :ref:`ColorPicker<class_colorpicker>` visibility
  36. Member Function Description
  37. ---------------------------
  38. .. _class_ColorPickerButton_get_pick_color:
  39. - :ref:`Color<class_color>` **get_pick_color** **(** **)** const
  40. .. _class_ColorPickerButton_get_picker:
  41. - :ref:`ColorPicker<class_colorpicker>` **get_picker** **(** **)**
  42. .. _class_ColorPickerButton_is_editing_alpha:
  43. - :ref:`bool<class_bool>` **is_editing_alpha** **(** **)** const
  44. See :ref:`ColorPicker.is_edit_alpha<class_ColorPicker_is_edit_alpha>`
  45. .. _class_ColorPickerButton_set_edit_alpha:
  46. - void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
  47. See :ref:`ColorPicker.set_edit_alpha<class_ColorPicker_set_edit_alpha>`
  48. .. _class_ColorPickerButton_set_pick_color:
  49. - void **set_pick_color** **(** :ref:`Color<class_color>` color **)**
  50. Set new color to ColorRect.
  51. ::
  52. var cr = get_node("colorrect_node")
  53. cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red