======================
RadioButtons (hwx.gui)
======================

Group of mutually exclusive RadioButtons.

RadioButtons are mutually exclusive with other RadioButtons in the same container.

Only one radio botton can be switched on within the same container.

RadioButtons are usually used to create composite controls like VRadioButtons
or HRadioButtons.

Inherits:
  - :ref:`Widget (hwx.gui)`

--------------
Public Methods
--------------

  +---------------------------------------+
  | addChildren_ (self, children)         |
  +---------------------------------------+
  | clear_ (self)                         |
  +---------------------------------------+
  | destroy_ (self)                       |
  +---------------------------------------+
  | enableGlobalActions_ (self, enable)   |
  +---------------------------------------+
  | getMousePosition_ (self)              |
  +---------------------------------------+
  | getRelativeMousePosition_ (self)      |
  +---------------------------------------+
  | hide_ (self)                          |
  +---------------------------------------+
  | saveAsPng_ (self, fname)              |
  +---------------------------------------+
  | setF1HelpTopic_ (self, helptopic)     |
  +---------------------------------------+
  | setProperties_ (self, kwds)           |
  +---------------------------------------+
  | setValues_ (self, values, value=None) |
  +---------------------------------------+
  | show_ (self)                          |
  +---------------------------------------+

--------------
Method Details
--------------

.. _addChildren:
.. method:: addChildren(self, children)

Add child widgets/layouts into this widget.

Widget children get layed out using a VBoxLayout.

Typically, you'll pass the parent/children into the constructor instead of
calling this function directly.

:param children:
:type children: list[Widget] | Layout


.. _clear:
.. method:: clear(self)

Destroys the button.

.. _destroy:
.. method:: destroy(self)

Deletes this and all its children.

.. _enableGlobalActions:
.. method:: enableGlobalActions(self, enable)

Sets the state of Global Actions.

Disable the global actions to get key events.

:param enable: Determines whether to enable or disable global actions.
:type enable: bool


.. _getMousePosition:
.. method:: getMousePosition(self)

Returns the mouse position.

.. _getRelativeMousePosition:
.. method:: getRelativeMousePosition(self)

Returns the mouse position relative to this widget.

.. _hide:
.. method:: hide(self)

Hides the widget.

.. _saveAsPng:
.. method:: saveAsPng(self, fname)

Saves the widget as a .png file.

:param fname: The file name for the .png
:type fname: str

:returns: True if it was saved succesfully, False otherwise.
:rtype: bool


.. _setF1HelpTopic:
.. method:: setF1HelpTopic(self, helptopic)

Popup web-browser helps when the user hits F1 when over this.

:param helptopic: Topic name user needs help in.
:type helptopic: str


.. _setProperties:
.. method:: setProperties(self, kwds)

Internal method called from constructors.

.. _setValues:
.. method:: setValues(self, values, value=None)

Specify the options. A button is created for each option.

:param values: list of (value, displayName) tuples.
:type values: list[str, str]
:param value: Set new values.
:type value: list[str] | list[int]


.. _show:
.. method:: show(self)

Shows the widget.