class_hseparator.rst 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the HSeparator.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_HSeparator:
  6. HSeparator
  7. ==========
  8. **Inherits:** :ref:`Separator<class_Separator>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. Horizontal separator.
  10. Description
  11. -----------
  12. Horizontal separator. See :ref:`Separator<class_Separator>`. Even though it looks horizontal, it is used to separate objects vertically.
  13. Theme Properties
  14. ----------------
  15. +---------------------------------+---------------------------------------------------------------+-------+
  16. | :ref:`int<class_int>` | :ref:`separation<class_HSeparator_theme_constant_separation>` | ``4`` |
  17. +---------------------------------+---------------------------------------------------------------+-------+
  18. | :ref:`StyleBox<class_StyleBox>` | :ref:`separator<class_HSeparator_theme_style_separator>` | |
  19. +---------------------------------+---------------------------------------------------------------+-------+
  20. Theme Property Descriptions
  21. ---------------------------
  22. .. _class_HSeparator_theme_constant_separation:
  23. - :ref:`int<class_int>` **separation**
  24. +-----------+-------+
  25. | *Default* | ``4`` |
  26. +-----------+-------+
  27. The height of the area covered by the separator. Effectively works like a minimum height.
  28. ----
  29. .. _class_HSeparator_theme_style_separator:
  30. - :ref:`StyleBox<class_StyleBox>` **separator**
  31. The style for the separator line. Works best with :ref:`StyleBoxLine<class_StyleBoxLine>`.
  32. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  33. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  34. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`