diff options
Diffstat (limited to 'doc/classes/CheckButton.xml')
| -rw-r--r-- | doc/classes/CheckButton.xml | 66 |
1 files changed, 44 insertions, 22 deletions
diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml index 514ff9a691..a0a05bcb79 100644 --- a/doc/classes/CheckButton.xml +++ b/doc/classes/CheckButton.xml @@ -5,6 +5,7 @@ </brief_description> <description> CheckButton is a toggle button displayed as a check field. It's similar to [CheckBox] in functionality, but it has a different appearance. 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. + See also [BaseButton] which contains common properties and methods associated with this node. </description> <tutorials> </tutorials> @@ -17,58 +18,79 @@ <constants> </constants> <theme_items> - <theme_item name="check_vadjust" type="int" default="0"> + <theme_item name="check_vadjust" data_type="constant" type="int" default="0"> The vertical offset used when rendering the toggle icons (in pixels). </theme_item> - <theme_item name="disabled" type="StyleBox"> + <theme_item name="disabled" data_type="style" type="StyleBox"> The [StyleBox] to display as a background when the [CheckButton] is disabled. </theme_item> - <theme_item name="focus" type="StyleBox"> + <theme_item name="focus" data_type="style" type="StyleBox"> The [StyleBox] to display as a background when the [CheckButton] is focused. </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="font" data_type="font" type="Font"> The [Font] to use for the [CheckButton] text. </theme_item> - <theme_item name="font_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )"> + <theme_item name="font_color" data_type="color" type="Color" default="Color(0.88, 0.88, 0.88, 1)"> The [CheckButton] text's font color. </theme_item> - <theme_item name="font_color_disabled" type="Color" default="Color( 0.9, 0.9, 0.9, 0.2 )"> + <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.9, 0.9, 0.9, 0.2)"> The [CheckButton] text's font color when it's disabled. </theme_item> - <theme_item name="font_color_hover" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )"> + <theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> The [CheckButton] text's font color when it's hovered. </theme_item> - <theme_item name="font_color_hover_pressed" type="Color" default="Color( 1, 1, 1, 1 )"> + <theme_item name="font_hover_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> The [CheckButton] text's font color when it's hovered and pressed. </theme_item> - <theme_item name="font_color_pressed" type="Color" default="Color( 1, 1, 1, 1 )"> + <theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> + The tint of text outline of the [CheckButton]. + </theme_item> + <theme_item name="font_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> The [CheckButton] text's font color when it's pressed. </theme_item> - <theme_item name="hover" type="StyleBox"> + <theme_item name="font_size" data_type="font_size" type="int"> + Font size of the [CheckButton]'s text. + </theme_item> + <theme_item name="hover" data_type="style" type="StyleBox"> The [StyleBox] to display as a background when the [CheckButton] is hovered. </theme_item> - <theme_item name="hover_pressed" type="StyleBox"> + <theme_item name="hover_pressed" data_type="style" type="StyleBox"> The [StyleBox] to display as a background when the [CheckButton] is hovered and pressed. </theme_item> - <theme_item name="hseparation" type="int" default="4"> + <theme_item name="hseparation" data_type="constant" type="int" default="4"> The separation between the toggle icon and the text (in pixels). </theme_item> - <theme_item name="normal" type="StyleBox"> + <theme_item name="normal" data_type="style" type="StyleBox"> The [StyleBox] to display as a background. </theme_item> - <theme_item name="off" type="Texture2D"> - The icon to display when the [CheckButton] is unchecked. + <theme_item name="off" data_type="icon" type="Texture2D"> + The icon to display when the [CheckButton] is unchecked (for left-to-right layouts). + </theme_item> + <theme_item name="off_disabled" data_type="icon" type="Texture2D"> + The icon to display when the [CheckButton] is unchecked and disabled (for left-to-right layouts). + </theme_item> + <theme_item name="off_disabled_mirrored" data_type="icon" type="Texture2D"> + The icon to display when the [CheckButton] is unchecked and disabled (for right-to-left layouts). + </theme_item> + <theme_item name="off_mirrored" data_type="icon" type="Texture2D"> + The icon to display when the [CheckButton] is unchecked (for right-to-left layouts). + </theme_item> + <theme_item name="on" data_type="icon" type="Texture2D"> + The icon to display when the [CheckButton] is checked (for left-to-right layouts). + </theme_item> + <theme_item name="on_disabled" data_type="icon" type="Texture2D"> + The icon to display when the [CheckButton] is checked and disabled (for left-to-right layouts). </theme_item> - <theme_item name="off_disabled" type="Texture2D"> - The icon to display when the [CheckButton] is unchecked and disabled. + <theme_item name="on_disabled_mirrored" data_type="icon" type="Texture2D"> + The icon to display when the [CheckButton] is checked and disabled (for right-to-left layouts). </theme_item> - <theme_item name="on" type="Texture2D"> - The icon to display when the [CheckButton] is checked. + <theme_item name="on_mirrored" data_type="icon" type="Texture2D"> + The icon to display when the [CheckButton] is checked (for right-to-left layouts). </theme_item> - <theme_item name="on_disabled" type="Texture2D"> - The icon to display when the [CheckButton] is checked and disabled. + <theme_item name="outline_size" data_type="constant" type="int" default="0"> + The size of the text outline. </theme_item> - <theme_item name="pressed" type="StyleBox"> + <theme_item name="pressed" data_type="style" type="StyleBox"> The [StyleBox] to display as a background when the [CheckButton] is pressed. </theme_item> </theme_items> |