class_toolbutton.rst 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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 ToolButton.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ToolButton:
  6. ToolButton
  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. Flat button helper class.
  10. Description
  11. -----------
  12. This is a helper class to generate a flat :ref:`Button<class_Button>` (see :ref:`Button.flat<class_Button_property_flat>`), creating a ``ToolButton`` is equivalent to:
  13. ::
  14. var btn = Button.new()
  15. btn.flat = true
  16. Properties
  17. ----------
  18. +-------------------------+------+------------------------------+
  19. | :ref:`bool<class_bool>` | flat | ``true`` *(parent override)* |
  20. +-------------------------+------+------------------------------+
  21. Theme Properties
  22. ----------------
  23. +---------------------------------+---------------------+------------------------------+
  24. | :ref:`StyleBox<class_StyleBox>` | disabled | |
  25. +---------------------------------+---------------------+------------------------------+
  26. | :ref:`StyleBox<class_StyleBox>` | focus | |
  27. +---------------------------------+---------------------+------------------------------+
  28. | :ref:`Font<class_Font>` | font | |
  29. +---------------------------------+---------------------+------------------------------+
  30. | :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
  31. +---------------------------------+---------------------+------------------------------+
  32. | :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.95, 1, 0.3 ) |
  33. +---------------------------------+---------------------+------------------------------+
  34. | :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
  35. +---------------------------------+---------------------+------------------------------+
  36. | :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
  37. +---------------------------------+---------------------+------------------------------+
  38. | :ref:`StyleBox<class_StyleBox>` | hover | |
  39. +---------------------------------+---------------------+------------------------------+
  40. | :ref:`int<class_int>` | hseparation | 3 |
  41. +---------------------------------+---------------------+------------------------------+
  42. | :ref:`StyleBox<class_StyleBox>` | normal | |
  43. +---------------------------------+---------------------+------------------------------+
  44. | :ref:`StyleBox<class_StyleBox>` | pressed | |
  45. +---------------------------------+---------------------+------------------------------+
  46. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  47. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  48. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`