class_checkbutton.rst 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the CheckButton.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CheckButton:
  6. CheckButton
  7. ===========
  8. **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>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Checkable button.
  13. Theme Properties
  14. ----------------
  15. +---------------------------------+--------------------------+------------------------------+
  16. | :ref:`int<class_int>` | check_vadjust | 0 |
  17. +---------------------------------+--------------------------+------------------------------+
  18. | :ref:`StyleBox<class_StyleBox>` | disabled | |
  19. +---------------------------------+--------------------------+------------------------------+
  20. | :ref:`StyleBox<class_StyleBox>` | focus | |
  21. +---------------------------------+--------------------------+------------------------------+
  22. | :ref:`Font<class_Font>` | font | |
  23. +---------------------------------+--------------------------+------------------------------+
  24. | :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
  25. +---------------------------------+--------------------------+------------------------------+
  26. | :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
  27. +---------------------------------+--------------------------+------------------------------+
  28. | :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
  29. +---------------------------------+--------------------------+------------------------------+
  30. | :ref:`Color<class_Color>` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) |
  31. +---------------------------------+--------------------------+------------------------------+
  32. | :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
  33. +---------------------------------+--------------------------+------------------------------+
  34. | :ref:`StyleBox<class_StyleBox>` | hover | |
  35. +---------------------------------+--------------------------+------------------------------+
  36. | :ref:`StyleBox<class_StyleBox>` | hover_pressed | |
  37. +---------------------------------+--------------------------+------------------------------+
  38. | :ref:`int<class_int>` | hseparation | 4 |
  39. +---------------------------------+--------------------------+------------------------------+
  40. | :ref:`StyleBox<class_StyleBox>` | normal | |
  41. +---------------------------------+--------------------------+------------------------------+
  42. | :ref:`Texture<class_Texture>` | off | |
  43. +---------------------------------+--------------------------+------------------------------+
  44. | :ref:`Texture<class_Texture>` | off_disabled | |
  45. +---------------------------------+--------------------------+------------------------------+
  46. | :ref:`Texture<class_Texture>` | on | |
  47. +---------------------------------+--------------------------+------------------------------+
  48. | :ref:`Texture<class_Texture>` | on_disabled | |
  49. +---------------------------------+--------------------------+------------------------------+
  50. | :ref:`StyleBox<class_StyleBox>` | pressed | |
  51. +---------------------------------+--------------------------+------------------------------+
  52. Description
  53. -----------
  54. CheckButton is a toggle button displayed as a check field.