Skip to content

Latest commit

 

History

History
53 lines (28 loc) · 1.23 KB

radio-button.rst

File metadata and controls

53 lines (28 loc) · 1.23 KB
Raw

RadioButton

This functions as a button that allows toggling between being selected (checked) or deselected (unchecked). Generally, these buttons offer users a choice among several options where only one can be selected at a time. Within a set of radio buttons, selecting a new option automatically deselects the previously chosen one.

Properties

local check = RadioButton(text)
.. function:: setOnCheck(callback)

  Executed when checked. Arguments passed include self and state.


.. function:: setIcon(path)

  Sets an icon on the radio button

checkout :doc:`Using resources </user-resources>`

.. function:: setIconSize(width, height)

  Sets the icon size


.. function:: setToolTip(text)

  Tooltips are brief informational messages that appear when the user hovers the mouse pointer over the tab


.. function:: setToolTipDuration(duration)

  Set how long the tooltip displays


.. function:: getToolTip()

  Returns the tooltip text


.. function:: getCheck()

  Returns check status; ``true`` or ``false``


.. function:: setCheck(check: bool)

  Sets the box to be checked or not


.. function:: setText(text)

  Sets the radio button text


.. function:: getText()

  Gets the radio button button