summaryrefslogtreecommitdiffstats
path: root/doc/classes/CheckBox.xml
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2023-09-26 16:41:24 +0200
committerYuri Sizov <yuris@humnom.net>2023-09-26 18:48:51 +0200
commit596dd726a111fe5bea76165bcdfe44dc06e01244 (patch)
tree16c81589fa4f81fa317e84a4b7a07b9710d38030 /doc/classes/CheckBox.xml
parent36945dad0730ee013547493df60c4c59567b4290 (diff)
downloadredot-engine-596dd726a111fe5bea76165bcdfe44dc06e01244.tar.gz
Use bound theme properties for documentation
Diffstat (limited to 'doc/classes/CheckBox.xml')
-rw-r--r--doc/classes/CheckBox.xml52
1 files changed, 0 insertions, 52 deletions
diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml
index fb733a95b8..5b2c93f7b3 100644
--- a/doc/classes/CheckBox.xml
+++ b/doc/classes/CheckBox.xml
@@ -15,43 +15,9 @@
<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" overrides="BaseButton" default="true" />
</members>
<theme_items>
- <theme_item name="font_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)">
- The [CheckBox] text's font color.
- </theme_item>
- <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.5)">
- The [CheckBox] text's font color when it's disabled.
- </theme_item>
- <theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
- The [CheckBox] text's font color when it's focused. Only replaces the normal text color of the checkbox. Disabled, hovered, and pressed states take precedence over this color.
- </theme_item>
- <theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
- The [CheckBox] text's font color when it's hovered.
- </theme_item>
- <theme_item name="font_hover_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
- The [CheckBox] text's font color when it's hovered and pressed.
- </theme_item>
- <theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
- The tint of text outline of the [CheckBox].
- </theme_item>
- <theme_item name="font_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
- The [CheckBox] text's font color when it's pressed.
- </theme_item>
<theme_item name="check_v_offset" data_type="constant" type="int" default="0">
The vertical offset used when rendering the check icons (in pixels).
</theme_item>
- <theme_item name="h_separation" data_type="constant" type="int" default="4">
- The separation between the check icon and the text (in pixels). Negative values will be treated as [code]0[/code] when used.
- </theme_item>
- <theme_item name="outline_size" data_type="constant" type="int" default="0">
- The size of the text outline.
- [b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
- </theme_item>
- <theme_item name="font" data_type="font" type="Font">
- The [Font] to use for the [CheckBox] text.
- </theme_item>
- <theme_item name="font_size" data_type="font_size" type="int">
- Font size of the [CheckBox]'s text.
- </theme_item>
<theme_item name="checked" data_type="icon" type="Texture2D">
The check icon to display when the [CheckBox] is checked.
</theme_item>
@@ -76,23 +42,5 @@
<theme_item name="unchecked_disabled" data_type="icon" type="Texture2D">
The check icon to display when the [CheckBox] is unchecked and is disabled.
</theme_item>
- <theme_item name="disabled" data_type="style" type="StyleBox">
- The [StyleBox] to display as a background when the [CheckBox] is disabled.
- </theme_item>
- <theme_item name="focus" data_type="style" type="StyleBox">
- The [StyleBox] to display as a background when the [CheckBox] is focused. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] the base [StyleBox], so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
- </theme_item>
- <theme_item name="hover" data_type="style" type="StyleBox">
- The [StyleBox] to display as a background when the [CheckBox] is hovered.
- </theme_item>
- <theme_item name="hover_pressed" data_type="style" type="StyleBox">
- The [StyleBox] to display as a background when the [CheckBox] is hovered and pressed.
- </theme_item>
- <theme_item name="normal" data_type="style" type="StyleBox">
- The [StyleBox] to display as a background.
- </theme_item>
- <theme_item name="pressed" data_type="style" type="StyleBox">
- The [StyleBox] to display as a background when the [CheckBox] is pressed.
- </theme_item>
</theme_items>
</class>