From 151a4ba6a59f6e965bb56ce8fbc75b14d056fa79 Mon Sep 17 00:00:00 2001 From: VolTer Date: Sun, 30 Apr 2023 16:26:09 +0200 Subject: Overhaul the top sections of the class reference (GUI classes) --- doc/classes/CheckBox.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/classes/CheckBox.xml') diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index 699073f9d3..b5d7c8d898 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -1,12 +1,12 @@ - Binary choice user interface widget. See also [CheckButton]. + A button that represents a binary choice. - 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. + [CheckBox] allows the user to choose one of only 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]. + When [member BaseButton.button_group] specifies a [ButtonGroup], [CheckBox] changes its appearance to that of a radio button and uses the various [code]radio_*[/code] theme properties. -- cgit v1.2.3