diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index 5ba159880e5..b5c7332bc14 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -1,10 +1,10 @@ - Binary choice user interface widget. + Binary choice user interface widget. See also [CheckButton]. - A checkbox allows the user to make a binary choice (choosing only one of two possible options). + 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 apperance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has [b]no[/b] immediate effect on something. For instance, it should be used when toggling it will only do something once a confirmation button is pressed. @@ -18,41 +18,58 @@ - The vertical offset used when rendering the check icons. + The vertical offset used when rendering the check icons (in pixels). + The check icon to display when the [CheckBox] is checked. + The [StyleBox] to display as a background when the [CheckBox] is disabled. + The [StyleBox] to display as a background when the [CheckBox] is focused. + The [Font] to use for the [CheckBox] text. + The [CheckBox] text's font color. + The [CheckBox] text's font color when it's disabled. + The [CheckBox] text's font color when it's hovered. + The [CheckBox] text's font color when it's hovered and pressed. + The [CheckBox] text's font color when it's pressed. + The [StyleBox] to display as a background when the [CheckBox] is hovered. + The [StyleBox] to display as a background when the [CheckBox] is hovered and pressed. + The separation between the check icon and the text (in pixels). + The [StyleBox] to display as a background. + The [StyleBox] to display as a background when the [CheckBox] is pressed. + If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is checked. + If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is unchecked. + The check icon to display when the [CheckBox] is unchecked. diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml index e6a890b21fe..769acb5d16a 100644 --- a/doc/classes/CheckButton.xml +++ b/doc/classes/CheckButton.xml @@ -1,10 +1,10 @@ - Checkable button. + Checkable button. See also [CheckBox]. - CheckButton is a toggle button displayed as a check field. + CheckButton is a toggle button displayed as a check field. It's similar to [CheckBox] in functionality, but it has a different apperance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an [b]immediate[/b] effect on something. For instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button. @@ -18,41 +18,58 @@ - The vertical offset used when rendering the icons. + The vertical offset used when rendering the toggle icons (in pixels). + The [StyleBox] to display as a background when the [CheckButton] is disabled. + The [StyleBox] to display as a background when the [CheckButton] is focused. + The [Font] to use for the [CheckButton] text. + The [CheckButton] text's font color. + The [CheckButton] text's font color when it's disabled. + The [CheckButton] text's font color when it's hovered. + The [CheckButton] text's font color when it's hovered and pressed. + The [CheckButton] text's font color when it's pressed. + The [StyleBox] to display as a background when the [CheckButton] is hovered. + The [StyleBox] to display as a background when the [CheckButton] is hovered and pressed. + The separation between the toggle icon and the text (in pixels). + The [StyleBox] to display as a background. + The icon to display when the [CheckButton] is unchecked. + The icon to display when the [CheckButton] is unchecked and disabled. + The icon to display when the [CheckButton] is checked. + The icon to display when the [CheckButton] is checked and disabled. + The [StyleBox] to display as a background when the [CheckButton] is pressed.