class_vslider.rst 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  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 VSlider.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VSlider:
  6. VSlider
  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. Vertical slider.
  10. Description
  11. -----------
  12. Vertical slider. See :ref:`Slider<class_Slider>`. This one goes from bottom (min) to top (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. Properties
  15. ----------
  16. +-----------------------+-----------------------+--------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | size_flags_horizontal | ``0`` (overrides :ref:`Control<class_Control_property_size_flags_horizontal>`) |
  18. +-----------------------+-----------------------+--------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | size_flags_vertical | ``1`` (overrides :ref:`Control<class_Control_property_size_flags_vertical>`) |
  20. +-----------------------+-----------------------+--------------------------------------------------------------------------------+
  21. Theme Properties
  22. ----------------
  23. +-----------------------------------+---------------------------------------------------------------------------------+
  24. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber<class_VSlider_theme_icon_grabber>` |
  25. +-----------------------------------+---------------------------------------------------------------------------------+
  26. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber_disabled<class_VSlider_theme_icon_grabber_disabled>` |
  27. +-----------------------------------+---------------------------------------------------------------------------------+
  28. | :ref:`Texture2D<class_Texture2D>` | :ref:`grabber_highlight<class_VSlider_theme_icon_grabber_highlight>` |
  29. +-----------------------------------+---------------------------------------------------------------------------------+
  30. | :ref:`Texture2D<class_Texture2D>` | :ref:`tick<class_VSlider_theme_icon_tick>` |
  31. +-----------------------------------+---------------------------------------------------------------------------------+
  32. | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area<class_VSlider_theme_style_grabber_area>` |
  33. +-----------------------------------+---------------------------------------------------------------------------------+
  34. | :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_area_highlight<class_VSlider_theme_style_grabber_area_highlight>` |
  35. +-----------------------------------+---------------------------------------------------------------------------------+
  36. | :ref:`StyleBox<class_StyleBox>` | :ref:`slider<class_VSlider_theme_style_slider>` |
  37. +-----------------------------------+---------------------------------------------------------------------------------+
  38. Theme Property Descriptions
  39. ---------------------------
  40. .. _class_VSlider_theme_icon_grabber:
  41. - :ref:`Texture2D<class_Texture2D>` **grabber**
  42. The texture for the grabber (the draggable element).
  43. ----
  44. .. _class_VSlider_theme_icon_grabber_disabled:
  45. - :ref:`Texture2D<class_Texture2D>` **grabber_disabled**
  46. The texture for the grabber when it's disabled.
  47. ----
  48. .. _class_VSlider_theme_icon_grabber_highlight:
  49. - :ref:`Texture2D<class_Texture2D>` **grabber_highlight**
  50. The texture for the grabber when it's focused.
  51. ----
  52. .. _class_VSlider_theme_icon_tick:
  53. - :ref:`Texture2D<class_Texture2D>` **tick**
  54. The texture for the ticks, visible when :ref:`Slider.tick_count<class_Slider_property_tick_count>` is greater than 0.
  55. ----
  56. .. _class_VSlider_theme_style_grabber_area:
  57. - :ref:`StyleBox<class_StyleBox>` **grabber_area**
  58. The background of the area below the grabber.
  59. ----
  60. .. _class_VSlider_theme_style_grabber_area_highlight:
  61. - :ref:`StyleBox<class_StyleBox>` **grabber_area_highlight**
  62. ----
  63. .. _class_VSlider_theme_style_slider:
  64. - :ref:`StyleBox<class_StyleBox>` **slider**
  65. The background for the whole slider. Determines the width of the ``grabber_area``.
  66. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  67. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  68. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  69. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  70. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  71. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`