.. default-domain:: cpp
.. highlight:: cpp
.. namespace:: krpc::services::UI

Slider
======


.. class:: Slider

   A control for choosing a number by dragging a handle along a track.
   Added to a :class:`Canvas` or a :class:`Panel`.

   .. function:: RectTransform rect_transform()

      The rect transform for the UI object.

   

   .. function:: LayoutElement layout_element()

      How much space the UI object asks a layout for.

   

      .. note::

         Only has an effect when the object is in a panel that has a layout. A canvas is
         not inside a layout and does not have one.

   .. function:: bool visible()
   .. function:: void set_visible(bool value)

      Whether the UI object is visible.

   

      .. note::

         This is the object's own setting, which is what it was last set to. An object is
         only drawn when everything it is inside is visible as well, so an interface can
         be built with its parts visible, inside a panel that is not, and shown all at
         once by making that panel visible.

   .. function:: float value()
   .. function:: void set_value(float value)

      The value of the slider, between :func:`Slider::min` and :func:`Slider::max`.
      Setting a value outside the range is refused.

   

   .. function:: float min()
   .. function:: void set_min(float value)

      The value at the low end of the slider, which is its left hand end, or the
      bottom of a vertical slider. Must not be greater than :func:`Slider::max`.

   

   .. function:: float max()
   .. function:: void set_max(float value)

      The value at the high end of the slider, which is its right hand end, or the
      top of a vertical slider. Must not be less than :func:`Slider::min`.

   

   .. function:: bool changed()
   .. function:: void set_changed(bool value)

      Whether the slider has been changed.

   

      .. note::

         This property is set to true when the user moves the slider, and not when a
         client sets its value.
         A client script should reset the property to false in order to detect subsequent changes.

   .. function:: bool interactable()
   .. function:: void set_interactable(bool value)

      Whether the control responds to the user.

   

      .. note::

         A control that is not interactable is drawn grayed out and ignores the user,
         but is still visible. Set its visibility to false to hide it instead.

   .. function:: StdLib::ColorRGBA color()
   .. function:: void set_color(StdLib::ColorRGBA value)

      The color the control is tinted with. White, the default, leaves the control drawn
      as the skin has it.

   

      .. note::

         The tint multiplies the sprite the control is drawn with, in every state, so
         a control can show a state of its own, an engaged autopilot for instance, by
         color. It is applied to the part of the control that responds to the user:
         the body of a button, dropdown or input field, the box of a toggle, and the
         handle of a slider. A control's label is tinted through the color of its
         text.

   .. function:: std::string tooltip()
   .. function:: void set_tooltip(std::string value)

      A short piece of text shown beside the pointer while it rests on the
      control. Empty, the default, shows nothing.

   

   .. function:: void remove()

      Remove the UI object.