Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[3.x] Sort and group theme properties in docs, improve formatting for theme and enums #55526

Merged
merged 1 commit into from
Dec 7, 2021
Merged

[3.x] Sort and group theme properties in docs, improve formatting for theme and enums #55526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions doc/classes/Button.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,6 @@
</constant>
</constants>
<theme_items>
<theme_item name="disabled" data_type="style" type="StyleBox">
[StyleBox] used when the [Button] is disabled.
</theme_item>
<theme_item name="focus" data_type="style" type="StyleBox">
[StyleBox] used when the [Button] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
</theme_item>
<theme_item name="font" data_type="font" type="Font">
[Font] of the [Button]'s text.
</theme_item>
<theme_item name="font_color" data_type="color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
Default text [Color] of the [Button].
</theme_item>
Expand All @@ -83,12 +74,21 @@
<theme_item name="font_color_pressed" data_type="color" type="Color" default="Color( 1, 1, 1, 1 )">
Text [Color] used when the [Button] is being pressed.
</theme_item>
<theme_item name="hover" data_type="style" type="StyleBox">
[StyleBox] used when the [Button] is being hovered.
</theme_item>
<theme_item name="hseparation" data_type="constant" type="int" default="2">
The horizontal space between [Button]'s icon and text.
</theme_item>
<theme_item name="font" data_type="font" type="Font">
[Font] of the [Button]'s text.
</theme_item>
<theme_item name="disabled" data_type="style" type="StyleBox">
[StyleBox] used when the [Button] is disabled.
</theme_item>
<theme_item name="focus" data_type="style" type="StyleBox">
[StyleBox] used when the [Button] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
</theme_item>
<theme_item name="hover" data_type="style" type="StyleBox">
[StyleBox] used when the [Button] is being hovered.
</theme_item>
<theme_item name="normal" data_type="style" type="StyleBox">
Default [StyleBox] for the [Button].
</theme_item>
Expand Down
54 changes: 27 additions & 27 deletions doc/classes/CheckBox.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,6 @@
<constants>
</constants>
<theme_items>
<theme_item name="check_vadjust" data_type="constant" type="int" default="0">
The vertical offset used when rendering the check icons (in pixels).
</theme_item>
<theme_item name="checked" data_type="icon" type="Texture">
The check icon to display when the [CheckBox] is checked.
</theme_item>
<theme_item name="checked_disabled" data_type="icon" type="Texture">
The check icon to display when the [CheckBox] is checked and 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.
</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_color" data_type="color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
The [CheckBox] text's font color.
</theme_item>
Expand All @@ -54,20 +36,20 @@
<theme_item name="font_color_pressed" 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="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 name="check_vadjust" data_type="constant" type="int" default="0">
The vertical offset used when rendering the check icons (in pixels).
</theme_item>
<theme_item name="hseparation" data_type="constant" type="int" default="4">
The separation between the check icon and the text (in pixels).
</theme_item>
<theme_item name="normal" data_type="style" type="StyleBox">
The [StyleBox] to display as a background.
<theme_item name="font" data_type="font" type="Font">
The [Font] to use for the [CheckBox] text.
</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 name="checked" data_type="icon" type="Texture">
The check icon to display when the [CheckBox] is checked.
</theme_item>
<theme_item name="checked_disabled" data_type="icon" type="Texture">
The check icon to display when the [CheckBox] is checked and disabled.
</theme_item>
<theme_item name="radio_checked" data_type="icon" type="Texture">
If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is checked.
Expand All @@ -85,5 +67,23 @@
<theme_item name="unchecked_disabled" data_type="icon" type="Texture">
The check icon to display when the [CheckBox] is unchecked and 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.
</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>
38 changes: 19 additions & 19 deletions doc/classes/CheckButton.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,6 @@
<constants>
</constants>
<theme_items>
<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" data_type="style" type="StyleBox">
The [StyleBox] to display as a background when the [CheckButton] is disabled.
</theme_item>
<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" data_type="font" type="Font">
The [Font] to use for the [CheckButton] text.
</theme_item>
<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>
Expand All @@ -48,17 +36,14 @@
<theme_item name="font_color_pressed" 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" data_type="style" type="StyleBox">
The [StyleBox] to display as a background when the [CheckButton] is hovered.
</theme_item>
<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 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="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" data_type="style" type="StyleBox">
The [StyleBox] to display as a background.
<theme_item name="font" data_type="font" type="Font">
The [Font] to use for the [CheckButton] text.
</theme_item>
<theme_item name="off" data_type="icon" type="Texture">
The icon to display when the [CheckButton] is unchecked.
Expand All @@ -72,6 +57,21 @@
<theme_item name="on_disabled" data_type="icon" type="Texture">
The icon to display when the [CheckButton] is checked and disabled.
</theme_item>
<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" data_type="style" type="StyleBox">
The [StyleBox] to display as a background when the [CheckButton] is focused.
</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" data_type="style" type="StyleBox">
The [StyleBox] to display as a background when the [CheckButton] 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 [CheckButton] is pressed.
</theme_item>
Expand Down
28 changes: 14 additions & 14 deletions doc/classes/ColorPicker.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,6 @@
<constants>
</constants>
<theme_items>
<theme_item name="add_preset" data_type="icon" type="Texture">
The icon for the "Add Preset" button.
</theme_item>
<theme_item name="color_hue" data_type="icon" type="Texture">
Custom texture for the hue selection slider on the right.
</theme_item>
<theme_item name="color_sample" data_type="icon" type="Texture">
</theme_item>
<theme_item name="h_width" data_type="constant" type="int" default="30">
The width of the hue selection slider.
</theme_item>
Expand All @@ -97,6 +89,20 @@
<theme_item name="margin" data_type="constant" type="int" default="4">
The margin around the [ColorPicker].
</theme_item>
<theme_item name="sv_height" data_type="constant" type="int" default="256">
The height of the saturation-value selection box.
</theme_item>
<theme_item name="sv_width" data_type="constant" type="int" default="256">
The width of the saturation-value selection box.
</theme_item>
<theme_item name="add_preset" data_type="icon" type="Texture">
The icon for the "Add Preset" button.
</theme_item>
<theme_item name="color_hue" data_type="icon" type="Texture">
Custom texture for the hue selection slider on the right.
</theme_item>
<theme_item name="color_sample" data_type="icon" type="Texture">
</theme_item>
<theme_item name="overbright_indicator" data_type="icon" type="Texture">
The indicator used to signalize that the color value is outside the 0-1 range.
</theme_item>
Expand All @@ -105,11 +111,5 @@
<theme_item name="screen_picker" data_type="icon" type="Texture">
The icon for the screen color picker button.
</theme_item>
<theme_item name="sv_height" data_type="constant" type="int" default="256">
The height of the saturation-value selection box.
</theme_item>
<theme_item name="sv_width" data_type="constant" type="int" default="256">
The width of the saturation-value selection box.
</theme_item>
</theme_items>
</class>
30 changes: 15 additions & 15 deletions doc/classes/ColorPickerButton.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,6 @@
<constants>
</constants>
<theme_items>
<theme_item name="bg" data_type="icon" type="Texture">
The background of the color preview rect on the button.
</theme_item>
<theme_item name="disabled" data_type="style" type="StyleBox">
[StyleBox] used when the [ColorPickerButton] is disabled.
</theme_item>
<theme_item name="focus" data_type="style" type="StyleBox">
[StyleBox] used when the [ColorPickerButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
</theme_item>
<theme_item name="font" data_type="font" type="Font">
[Font] of the [ColorPickerButton]'s text.
</theme_item>
<theme_item name="font_color" data_type="color" type="Color" default="Color( 1, 1, 1, 1 )">
Default text [Color] of the [ColorPickerButton].
</theme_item>
Expand All @@ -85,12 +73,24 @@
<theme_item name="font_color_pressed" data_type="color" type="Color" default="Color( 0.8, 0.8, 0.8, 1 )">
Text [Color] used when the [ColorPickerButton] is being pressed.
</theme_item>
<theme_item name="hover" data_type="style" type="StyleBox">
[StyleBox] used when the [ColorPickerButton] is being hovered.
</theme_item>
<theme_item name="hseparation" data_type="constant" type="int" default="2">
The horizontal space between [ColorPickerButton]'s icon and text.
</theme_item>
<theme_item name="font" data_type="font" type="Font">
[Font] of the [ColorPickerButton]'s text.
</theme_item>
<theme_item name="bg" data_type="icon" type="Texture">
The background of the color preview rect on the button.
</theme_item>
<theme_item name="disabled" data_type="style" type="StyleBox">
[StyleBox] used when the [ColorPickerButton] is disabled.
</theme_item>
<theme_item name="focus" data_type="style" type="StyleBox">
[StyleBox] used when the [ColorPickerButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
</theme_item>
<theme_item name="hover" data_type="style" type="StyleBox">
[StyleBox] used when the [ColorPickerButton] is being hovered.
</theme_item>
<theme_item name="normal" data_type="style" type="StyleBox">
Default [StyleBox] for the [ColorPickerButton].
</theme_item>
Expand Down
12 changes: 6 additions & 6 deletions doc/classes/FileDialog.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,21 +125,21 @@
</constant>
</constants>
<theme_items>
<theme_item name="file" data_type="icon" type="Texture">
Custom icon for files.
</theme_item>
<theme_item name="file_icon_modulate" data_type="color" type="Color" default="Color( 1, 1, 1, 1 )">
The color modulation applied to the file icon.
</theme_item>
<theme_item name="files_disabled" data_type="color" type="Color" default="Color( 0, 0, 0, 0.7 )">
The color tint for disabled files (when the [FileDialog] is used in open folder mode).
</theme_item>
<theme_item name="folder" data_type="icon" type="Texture">
Custom icon for folders.
</theme_item>
<theme_item name="folder_icon_modulate" data_type="color" type="Color" default="Color( 1, 1, 1, 1 )">
The color modulation applied to the folder icon.
</theme_item>
<theme_item name="file" data_type="icon" type="Texture">
Custom icon for files.
</theme_item>
<theme_item name="folder" data_type="icon" type="Texture">
Custom icon for folders.
</theme_item>
<theme_item name="parent_folder" data_type="icon" type="Texture">
Custom icon for the parent folder arrow.
</theme_item>
Expand Down
36 changes: 18 additions & 18 deletions doc/classes/GraphEdit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,44 +264,44 @@
<theme_items>
<theme_item name="activity" data_type="color" type="Color" default="Color( 1, 1, 1, 1 )">
</theme_item>
<theme_item name="bezier_len_neg" data_type="constant" type="int" default="160">
</theme_item>
<theme_item name="bezier_len_pos" data_type="constant" type="int" default="80">
</theme_item>
<theme_item name="bg" data_type="style" type="StyleBox">
The background drawn under the grid.
</theme_item>
<theme_item name="grid_major" data_type="color" type="Color" default="Color( 1, 1, 1, 0.2 )">
Color of major grid lines.
</theme_item>
<theme_item name="grid_minor" data_type="color" type="Color" default="Color( 1, 1, 1, 0.05 )">
Color of minor grid lines.
</theme_item>
<theme_item name="minimap" data_type="icon" type="Texture">
<theme_item name="selection_fill" data_type="color" type="Color" default="Color( 1, 1, 1, 0.3 )">
The fill color of the selection rectangle.
</theme_item>
<theme_item name="minus" data_type="icon" type="Texture">
The icon for the zoom out button.
<theme_item name="selection_stroke" data_type="color" type="Color" default="Color( 1, 1, 1, 0.8 )">
The outline color of the selection rectangle.
</theme_item>
<theme_item name="more" data_type="icon" type="Texture">
The icon for the zoom in button.
<theme_item name="bezier_len_neg" data_type="constant" type="int" default="160">
</theme_item>
<theme_item name="bezier_len_pos" data_type="constant" type="int" default="80">
</theme_item>
<theme_item name="port_grab_distance_horizontal" data_type="constant" type="int" default="24">
The horizontal range within which a port can be grabbed (on both sides).
</theme_item>
<theme_item name="port_grab_distance_vertical" data_type="constant" type="int" default="6">
The vertical range within which a port can be grabbed (on both sides).
</theme_item>
<theme_item name="reset" data_type="icon" type="Texture">
The icon for the zoom reset button.
<theme_item name="minimap" data_type="icon" type="Texture">
</theme_item>
<theme_item name="selection_fill" data_type="color" type="Color" default="Color( 1, 1, 1, 0.3 )">
The fill color of the selection rectangle.
<theme_item name="minus" data_type="icon" type="Texture">
The icon for the zoom out button.
</theme_item>
<theme_item name="selection_stroke" data_type="color" type="Color" default="Color( 1, 1, 1, 0.8 )">
The outline color of the selection rectangle.
<theme_item name="more" data_type="icon" type="Texture">
The icon for the zoom in button.
</theme_item>
<theme_item name="reset" data_type="icon" type="Texture">
The icon for the zoom reset button.
</theme_item>
<theme_item name="snap" data_type="icon" type="Texture">
The icon for the snap toggle button.
</theme_item>
<theme_item name="bg" data_type="style" type="StyleBox">
The background drawn under the grid.
</theme_item>
</theme_items>
</class>
Loading