class_checkbox.rst 4.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the CheckBox.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_CheckBox:
  5. CheckBox
  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. Binary choice user interface widget.
  12. Theme Properties
  13. ----------------
  14. +---------------------------------+--------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`check_vadjust<class_CheckBox_check_vadjust>` |
  16. +---------------------------------+--------------------------------------------------------------------------+
  17. | :ref:`Texture<class_Texture>` | :ref:`checked<class_CheckBox_checked>` |
  18. +---------------------------------+--------------------------------------------------------------------------+
  19. | :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_CheckBox_disabled>` |
  20. +---------------------------------+--------------------------------------------------------------------------+
  21. | :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_CheckBox_focus>` |
  22. +---------------------------------+--------------------------------------------------------------------------+
  23. | :ref:`Font<class_Font>` | :ref:`font<class_CheckBox_font>` |
  24. +---------------------------------+--------------------------------------------------------------------------+
  25. | :ref:`Color<class_Color>` | :ref:`font_color<class_CheckBox_font_color>` |
  26. +---------------------------------+--------------------------------------------------------------------------+
  27. | :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_CheckBox_font_color_disabled>` |
  28. +---------------------------------+--------------------------------------------------------------------------+
  29. | :ref:`Color<class_Color>` | :ref:`font_color_hover<class_CheckBox_font_color_hover>` |
  30. +---------------------------------+--------------------------------------------------------------------------+
  31. | :ref:`Color<class_Color>` | :ref:`font_color_hover_pressed<class_CheckBox_font_color_hover_pressed>` |
  32. +---------------------------------+--------------------------------------------------------------------------+
  33. | :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_CheckBox_font_color_pressed>` |
  34. +---------------------------------+--------------------------------------------------------------------------+
  35. | :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_CheckBox_hover>` |
  36. +---------------------------------+--------------------------------------------------------------------------+
  37. | :ref:`StyleBox<class_StyleBox>` | :ref:`hover_pressed<class_CheckBox_hover_pressed>` |
  38. +---------------------------------+--------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`hseparation<class_CheckBox_hseparation>` |
  40. +---------------------------------+--------------------------------------------------------------------------+
  41. | :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_CheckBox_normal>` |
  42. +---------------------------------+--------------------------------------------------------------------------+
  43. | :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_CheckBox_pressed>` |
  44. +---------------------------------+--------------------------------------------------------------------------+
  45. | :ref:`Texture<class_Texture>` | :ref:`radio_checked<class_CheckBox_radio_checked>` |
  46. +---------------------------------+--------------------------------------------------------------------------+
  47. | :ref:`Texture<class_Texture>` | :ref:`radio_unchecked<class_CheckBox_radio_unchecked>` |
  48. +---------------------------------+--------------------------------------------------------------------------+
  49. | :ref:`Texture<class_Texture>` | :ref:`unchecked<class_CheckBox_unchecked>` |
  50. +---------------------------------+--------------------------------------------------------------------------+
  51. Description
  52. -----------
  53. A checkbox allows the user to make a binary choice (choosing only one of two possible options), for example Answer 'yes' or 'no'.