class_hslider.rst 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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/HSlider.xml.
  6. .. _class_HSlider:
  7. HSlider
  8. =======
  9. **Inherits:** :ref:`Slider<class_Slider>` **<** :ref:`Range<class_Range>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. Horizontal slider.
  11. Description
  12. -----------
  13. Horizontal slider. See :ref:`Slider<class_Slider>`. This one goes from left (min) to right (max).
  14. \ **Note:** The :ref:`Range.changed<class_Range_signal_changed>` and :ref:`Range.value_changed<class_Range_signal_value_changed>` signals are part of the :ref:`Range<class_Range>` class which this class inherits from.
  15. Theme Properties
  16. ----------------
  17. +-----------------------------------+---------------------------------------------------------------------------------+-------+
  18. | :ref:`int<class_int>` | :ref:`grabber_offset<class_HSlider_theme_constant_grabber_offset>` | ``0`` |
  19. +-----------------------------------+---------------------------------------------------------------------------------+-------+
  20. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber<class_HSlider_theme_icon_grabber>` | |
  21. +-----------------------------------+---------------------------------------------------------------------------------+-------+
  22. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber_disabled<class_HSlider_theme_icon_grabber_disabled>` | |
  23. +-----------------------------------+---------------------------------------------------------------------------------+-------+
  24. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber_highlight<class_HSlider_theme_icon_grabber_highlight>` | |
  25. +-----------------------------------+---------------------------------------------------------------------------------+-------+
  26. | :ref:`Texture2D<class_Texture2D>` | :ref:`tick<class_HSlider_theme_icon_tick>` | |
  27. +-----------------------------------+---------------------------------------------------------------------------------+-------+
  28. | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area<class_HSlider_theme_style_grabber_area>` | |
  29. +-----------------------------------+---------------------------------------------------------------------------------+-------+
  30. | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area_highlight<class_HSlider_theme_style_grabber_area_highlight>` | |
  31. +-----------------------------------+---------------------------------------------------------------------------------+-------+
  32. | :ref:`StyleBox<class_StyleBox>` | :ref:`slider<class_HSlider_theme_style_slider>` | |
  33. +-----------------------------------+---------------------------------------------------------------------------------+-------+
  34. Theme Property Descriptions
  35. ---------------------------
  36. .. _class_HSlider_theme_constant_grabber_offset:
  37. - :ref:`int<class_int>` **grabber_offset**
  38. +-----------+-------+
  39. | *Default* | ``0`` |
  40. +-----------+-------+
  41. Vertical offset of the grabber.
  42. ----
  43. .. _class_HSlider_theme_icon_grabber:
  44. - :ref:`Texture2D<class_Texture2D>` **grabber**
  45. The texture for the grabber (the draggable element).
  46. ----
  47. .. _class_HSlider_theme_icon_grabber_disabled:
  48. - :ref:`Texture2D<class_Texture2D>` **grabber_disabled**
  49. The texture for the grabber when it's disabled.
  50. ----
  51. .. _class_HSlider_theme_icon_grabber_highlight:
  52. - :ref:`Texture2D<class_Texture2D>` **grabber_highlight**
  53. The texture for the grabber when it's focused.
  54. ----
  55. .. _class_HSlider_theme_icon_tick:
  56. - :ref:`Texture2D<class_Texture2D>` **tick**
  57. The texture for the ticks, visible when :ref:`Slider.tick_count<class_Slider_property_tick_count>` is greater than 0.
  58. ----
  59. .. _class_HSlider_theme_style_grabber_area:
  60. - :ref:`StyleBox<class_StyleBox>` **grabber_area**
  61. The background of the area to the left of the grabber.
  62. ----
  63. .. _class_HSlider_theme_style_grabber_area_highlight:
  64. - :ref:`StyleBox<class_StyleBox>` **grabber_area_highlight**
  65. ----
  66. .. _class_HSlider_theme_style_slider:
  67. - :ref:`StyleBox<class_StyleBox>` **slider**
  68. The background for the whole slider. Determines the height of the ``grabber_area``.
  69. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  70. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  71. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  72. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  73. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  74. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`