class_hslider.rst 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  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 HSlider.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_HSlider:
  6. HSlider
  7. =======
  8. **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>`
  9. Horizontal slider.
  10. Description
  11. -----------
  12. Horizontal slider. See :ref:`Slider<class_Slider>`. This one goes from left (min) to right (max).
  13. \ **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.
  14. Theme Properties
  15. ----------------
  16. +-----------------------------------+---------------------------------------------------------------------------------+
  17. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber<class_HSlider_theme_icon_grabber>` |
  18. +-----------------------------------+---------------------------------------------------------------------------------+
  19. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber_disabled<class_HSlider_theme_icon_grabber_disabled>` |
  20. +-----------------------------------+---------------------------------------------------------------------------------+
  21. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber_highlight<class_HSlider_theme_icon_grabber_highlight>` |
  22. +-----------------------------------+---------------------------------------------------------------------------------+
  23. | :ref:`Texture2D<class_Texture2D>` | :ref:`tick<class_HSlider_theme_icon_tick>` |
  24. +-----------------------------------+---------------------------------------------------------------------------------+
  25. | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area<class_HSlider_theme_style_grabber_area>` |
  26. +-----------------------------------+---------------------------------------------------------------------------------+
  27. | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area_highlight<class_HSlider_theme_style_grabber_area_highlight>` |
  28. +-----------------------------------+---------------------------------------------------------------------------------+
  29. | :ref:`StyleBox<class_StyleBox>` | :ref:`slider<class_HSlider_theme_style_slider>` |
  30. +-----------------------------------+---------------------------------------------------------------------------------+
  31. Theme Property Descriptions
  32. ---------------------------
  33. .. _class_HSlider_theme_icon_grabber:
  34. - :ref:`Texture2D<class_Texture2D>` **grabber**
  35. The texture for the grabber (the draggable element).
  36. ----
  37. .. _class_HSlider_theme_icon_grabber_disabled:
  38. - :ref:`Texture2D<class_Texture2D>` **grabber_disabled**
  39. The texture for the grabber when it's disabled.
  40. ----
  41. .. _class_HSlider_theme_icon_grabber_highlight:
  42. - :ref:`Texture2D<class_Texture2D>` **grabber_highlight**
  43. The texture for the grabber when it's focused.
  44. ----
  45. .. _class_HSlider_theme_icon_tick:
  46. - :ref:`Texture2D<class_Texture2D>` **tick**
  47. The texture for the ticks, visible when :ref:`Slider.tick_count<class_Slider_property_tick_count>` is greater than 0.
  48. ----
  49. .. _class_HSlider_theme_style_grabber_area:
  50. - :ref:`StyleBox<class_StyleBox>` **grabber_area**
  51. The background of the area to the left of the grabber.
  52. ----
  53. .. _class_HSlider_theme_style_grabber_area_highlight:
  54. - :ref:`StyleBox<class_StyleBox>` **grabber_area_highlight**
  55. ----
  56. .. _class_HSlider_theme_style_slider:
  57. - :ref:`StyleBox<class_StyleBox>` **slider**
  58. The background for the whole slider. Determines the height of the ``grabber_area``.
  59. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  60. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  61. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  62. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  63. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  64. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`