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

Toggle
======


.. class:: Toggle

   A control that is either checked or not.
   Added to a :class:`Canvas` or a :class:`Panel`.

   .. note::

      On its own a toggle is a check box. Put several of them in the same
      :class:`ToggleGroup` and they become radio buttons, as only one toggle in a
      group can be checked at a time.

   .. 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:: Text text()

      The text for the toggle.

   

   .. function:: bool checked()
   .. function:: void set_checked(bool value)

      Whether the toggle is checked.

   

      .. note::

         Checking a toggle that belongs to a :class:`ToggleGroup` unchecks the rest
         of that group, whether or not it is on the screen.

   .. function:: std::optional<ToggleGroup> group()
   .. function:: void set_group(std::optional<ToggleGroup> value)

      The group that the toggle belongs to, or ``NULL`` if it does not belong to one.

   

      .. note::

         Only one toggle in a group can be checked at a time, so a group turns a set of
         toggles into radio buttons. A group does not have to contain the toggles, so
         they can be grouped independently of how they are laid out.

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

      Whether the toggle has been changed.

   

      .. note::

         This property is set to true when the user changes the toggle, and not when a
         client checks or unchecks it.
         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.