class_hseparator.rst 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HSeparator.xml.
  6. .. _class_HSeparator:
  7. HSeparator
  8. ==========
  9. **Inherits:** :ref:`Separator<class_Separator>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. Horizontal separator.
  11. Description
  12. -----------
  13. Horizontal separator. See :ref:`Separator<class_Separator>`. Even though it looks horizontal, it is used to separate objects vertically.
  14. Theme Properties
  15. ----------------
  16. +---------------------------------+---------------------------------------------------------------+-------+
  17. | :ref:`int<class_int>` | :ref:`separation<class_HSeparator_theme_constant_separation>` | ``4`` |
  18. +---------------------------------+---------------------------------------------------------------+-------+
  19. | :ref:`StyleBox<class_StyleBox>` | :ref:`separator<class_HSeparator_theme_style_separator>` | |
  20. +---------------------------------+---------------------------------------------------------------+-------+
  21. Theme Property Descriptions
  22. ---------------------------
  23. .. _class_HSeparator_theme_constant_separation:
  24. - :ref:`int<class_int>` **separation**
  25. +-----------+-------+
  26. | *Default* | ``4`` |
  27. +-----------+-------+
  28. The height of the area covered by the separator. Effectively works like a minimum height.
  29. ----
  30. .. _class_HSeparator_theme_style_separator:
  31. - :ref:`StyleBox<class_StyleBox>` **separator**
  32. The style for the separator line. Works best with :ref:`StyleBoxLine<class_StyleBoxLine>`.
  33. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  34. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  35. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  36. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  37. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  38. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`