diff options
| author | Rindbee <idleman@yeah.net> | 2023-03-20 12:55:04 +0800 |
|---|---|---|
| committer | Rindbee <idleman@yeah.net> | 2023-03-21 06:55:51 +0800 |
| commit | 3dc487b450a8c8db8e60deaa244f68737a4603ed (patch) | |
| tree | ca80dc59522e57aec8797f8dedcae7e61c285d51 | |
| parent | 4d5f10fc3ad4e72c22391663c37d1f46510bb291 (diff) | |
| download | redot-engine-3dc487b450a8c8db8e60deaa244f68737a4603ed.tar.gz | |
Add instructions for configuring CheckBox as a radio button
| -rw-r--r-- | doc/classes/BaseButton.xml | 1 | ||||
| -rw-r--r-- | doc/classes/ButtonGroup.xml | 2 | ||||
| -rw-r--r-- | doc/classes/CheckBox.xml | 1 |
3 files changed, 3 insertions, 1 deletions
diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index d7f559498d..a934e1544a 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -49,6 +49,7 @@ </member> <member name="button_group" type="ButtonGroup" setter="set_button_group" getter="get_button_group"> The [ButtonGroup] associated with the button. Not to be confused with node groups. + [b]Note:[/b] The button will be configured as a radio button if a [ButtonGroup] is assigned to it. </member> <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" enum="MouseButtonMask" default="1"> Binary mask to choose which mouse buttons this button will respond to. diff --git a/doc/classes/ButtonGroup.xml b/doc/classes/ButtonGroup.xml index 670296fd45..3e153ea1aa 100644 --- a/doc/classes/ButtonGroup.xml +++ b/doc/classes/ButtonGroup.xml @@ -4,7 +4,7 @@ Group of Buttons. </brief_description> <description> - Group of [BaseButton]. The members of this group are treated like radio buttons in the sense that only one button can be pressed at the same time. + Group of [BaseButton]. The members of this group are treated like radio buttons in the sense that only one button can be pressed at the same time. Some types of buttons (such as [CheckBox]) may have a special appearance for this state. Every member of the ButtonGroup should have [member BaseButton.toggle_mode] set to [code]true[/code]. </description> <tutorials> diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index 9d98a1c1ed..699073f9d3 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -6,6 +6,7 @@ <description> A checkbox allows the user to make a binary choice (choosing only one of two possible options). It's similar to [CheckButton] in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has [b]no[/b] immediate effect on something. For example, it could be used when toggling it will only do something once a confirmation button is pressed. See also [BaseButton] which contains common properties and methods associated with this node. + [b]Note:[/b] CheckBox changes its appearance when it's configured as a radio button. See various [code]radio_*[/code] theme properties. To configure CheckBox to act as a radio button, use [member BaseButton.button_group] and [ButtonGroup]. </description> <tutorials> </tutorials> |