From e77c6aaba7a3f2752e728e140b32b983c2d76f58 Mon Sep 17 00:00:00 2001 From: Yuri Sizov Date: Wed, 1 Dec 2021 22:45:12 +0300 Subject: [PATCH] Sort and group theme properties in docs, improve formatting for theme and enums (cherry picked from commit ebd8101546ef704d24624ed2651dd9ca4043add7) --- doc/classes/Button.xml | 24 +++--- doc/classes/CheckBox.xml | 54 ++++++------- doc/classes/CheckButton.xml | 38 ++++----- doc/classes/ColorPicker.xml | 28 +++---- doc/classes/ColorPickerButton.xml | 30 +++---- doc/classes/FileDialog.xml | 12 +-- doc/classes/GraphEdit.xml | 38 ++++----- doc/classes/GraphNode.xml | 60 +++++++------- doc/classes/HScrollBar.xml | 18 ++--- doc/classes/HSlider.xml | 16 ++-- doc/classes/HSplitContainer.xml | 6 +- doc/classes/ItemList.xml | 36 ++++----- doc/classes/Label.xml | 12 +-- doc/classes/LineEdit.xml | 24 +++--- doc/classes/LinkButton.xml | 12 +-- doc/classes/MenuButton.xml | 24 +++--- doc/classes/OptionButton.xml | 34 ++++---- doc/classes/PopupMenu.xml | 48 ++++++------ doc/classes/ProgressBar.xml | 18 ++--- doc/classes/RichTextLabel.xml | 46 +++++------ doc/classes/TabContainer.xml | 36 ++++----- doc/classes/Tabs.xml | 44 +++++------ doc/classes/TextEdit.xml | 62 +++++++-------- doc/classes/ToolButton.xml | 24 +++--- doc/classes/Tree.xml | 126 +++++++++++++++--------------- doc/classes/VScrollBar.xml | 18 ++--- doc/classes/VSlider.xml | 16 ++-- doc/classes/VSplitContainer.xml | 6 +- doc/classes/WindowDialog.xml | 24 +++--- editor/doc/doc_data.cpp | 2 + editor/doc/doc_data.h | 6 +- editor/editor_help.cpp | 98 +++++++++++++++-------- editor/editor_help.h | 2 + 33 files changed, 540 insertions(+), 502 deletions(-) diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index e850f6a32db..2cd4eeaa600 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -59,15 +59,6 @@ - - [StyleBox] used when the [Button] is disabled. - - - [StyleBox] used when the [Button] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. - - - [Font] of the [Button]'s text. - Default text [Color] of the [Button]. @@ -83,12 +74,21 @@ Text [Color] used when the [Button] is being pressed. - - [StyleBox] used when the [Button] is being hovered. - The horizontal space between [Button]'s icon and text. + + [Font] of the [Button]'s text. + + + [StyleBox] used when the [Button] is disabled. + + + [StyleBox] used when the [Button] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. + + + [StyleBox] used when the [Button] is being hovered. + Default [StyleBox] for the [Button]. diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index 1d6e7fab2f2..b876fd9b05a 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -18,24 +18,6 @@ - - The vertical offset used when rendering the check icons (in pixels). - - - The check icon to display when the [CheckBox] is checked. - - - The check icon to display when the [CheckBox] is checked and disabled. - - - 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. @@ -54,20 +36,20 @@ 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 vertical offset used when rendering the check icons (in pixels). The separation between the check icon and the text (in pixels). - - The [StyleBox] to display as a background. + + The [Font] to use for the [CheckBox] text. - - The [StyleBox] to display as a background when the [CheckBox] is pressed. + + The check icon to display when the [CheckBox] is checked. + + + The check icon to display when the [CheckBox] is checked and disabled. If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is checked. @@ -85,5 +67,23 @@ The check icon to display when the [CheckBox] is unchecked and disabled. + + 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 [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 [StyleBox] to display as a background. + + + The [StyleBox] to display as a background when the [CheckBox] is pressed. + diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml index 57acd613a8f..8c66ebf2eab 100644 --- a/doc/classes/CheckButton.xml +++ b/doc/classes/CheckButton.xml @@ -18,18 +18,6 @@ - - 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. @@ -48,17 +36,14 @@ 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 vertical offset used when rendering the toggle icons (in pixels). The separation between the toggle icon and the text (in pixels). - - The [StyleBox] to display as a background. + + The [Font] to use for the [CheckButton] text. The icon to display when the [CheckButton] is unchecked. @@ -72,6 +57,21 @@ The icon to display when the [CheckButton] is checked and disabled. + + 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 [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 [StyleBox] to display as a background. + The [StyleBox] to display as a background when the [CheckButton] is pressed. diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index e0201446464..b31e10d9879 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -81,14 +81,6 @@ - - The icon for the "Add Preset" button. - - - Custom texture for the hue selection slider on the right. - - - The width of the hue selection slider. @@ -97,6 +89,20 @@ The margin around the [ColorPicker]. + + The height of the saturation-value selection box. + + + The width of the saturation-value selection box. + + + The icon for the "Add Preset" button. + + + Custom texture for the hue selection slider on the right. + + + The indicator used to signalize that the color value is outside the 0-1 range. @@ -105,11 +111,5 @@ The icon for the screen color picker button. - - The height of the saturation-value selection box. - - - The width of the saturation-value selection box. - diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index cf83798010c..2ee56da9e3a 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -58,18 +58,6 @@ - - The background of the color preview rect on the button. - - - [StyleBox] used when the [ColorPickerButton] is disabled. - - - [StyleBox] used when the [ColorPickerButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. - - - [Font] of the [ColorPickerButton]'s text. - Default text [Color] of the [ColorPickerButton]. @@ -85,12 +73,24 @@ Text [Color] used when the [ColorPickerButton] is being pressed. - - [StyleBox] used when the [ColorPickerButton] is being hovered. - The horizontal space between [ColorPickerButton]'s icon and text. + + [Font] of the [ColorPickerButton]'s text. + + + The background of the color preview rect on the button. + + + [StyleBox] used when the [ColorPickerButton] is disabled. + + + [StyleBox] used when the [ColorPickerButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. + + + [StyleBox] used when the [ColorPickerButton] is being hovered. + Default [StyleBox] for the [ColorPickerButton]. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index b884e7ed70a..e2a674fc75e 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -125,21 +125,21 @@ - - Custom icon for files. - The color modulation applied to the file icon. The color tint for disabled files (when the [FileDialog] is used in open folder mode). - - Custom icon for folders. - The color modulation applied to the folder icon. + + Custom icon for files. + + + Custom icon for folders. + Custom icon for the parent folder arrow. diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 2380b30aedd..4ff01b41272 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -264,19 +264,28 @@ - - - - - - The background drawn under the grid. - Color of major grid lines. Color of minor grid lines. + + The fill color of the selection rectangle. + + + The outline color of the selection rectangle. + + + + + + + The horizontal range within which a port can be grabbed (on both sides). + + + The vertical range within which a port can be grabbed (on both sides). + @@ -285,23 +294,14 @@ The icon for the zoom in button. - - The horizontal range within which a port can be grabbed (on both sides). - - - The vertical range within which a port can be grabbed (on both sides). - The icon for the zoom reset button. - - The fill color of the selection rectangle. - - - The outline color of the selection rectangle. - The icon for the snap toggle button. + + The background drawn under the grid. + diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index 786aef2660c..eae0b7c474a 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -264,17 +264,41 @@ - - The background used when [member overlay] is set to [constant OVERLAY_BREAKPOINT]. + + The color modulation applied to the close button icon. + + + The color modulation applied to the resizer icon. + + + Color of the title text. + + + The vertical offset of the close button. + + + Horizontal offset for the ports. + + + The vertical distance between ports. + + + Vertical offset of the title text. + + + Font used for the title text. The icon for the close button, visible when [member show_close] is enabled. - - The color modulation applied to the close button icon. + + The icon used for representing ports. - - The vertical offset of the close button. + + The icon used for resizer, visible when [member resizable] is enabled. + + + The background used when [member overlay] is set to [constant OVERLAY_BREAKPOINT]. The [StyleBox] used when [member comment] is enabled. @@ -289,35 +313,11 @@ The default background for [GraphNode]. - - The icon used for representing ports. - - - Horizontal offset for the ports. - The background used when [member overlay] is set to [constant OVERLAY_POSITION]. - - The icon used for resizer, visible when [member resizable] is enabled. - - - The color modulation applied to the resizer icon. - The background used when the [GraphNode] is selected. - - The vertical distance between ports. - - - Color of the title text. - - - Font used for the title text. - - - Vertical offset of the title text. - diff --git a/doc/classes/HScrollBar.xml b/doc/classes/HScrollBar.xml index abdde0c9307..f7098f364a8 100644 --- a/doc/classes/HScrollBar.xml +++ b/doc/classes/HScrollBar.xml @@ -22,15 +22,6 @@ Displayed when the decrement button is being pressed. - - Used as texture for the grabber, the draggable element representing current scroll. - - - Used when the mouse hovers over the grabber. - - - Used when the grabber is being dragged. - Icon used as a button to scroll the [ScrollBar] right. Supports custom step using the [member ScrollBar.custom_step] property. @@ -40,6 +31,15 @@ Displayed when the increment button is being pressed. + + Used as texture for the grabber, the draggable element representing current scroll. + + + Used when the mouse hovers over the grabber. + + + Used when the grabber is being dragged. + Used as background of this [ScrollBar]. diff --git a/doc/classes/HSlider.xml b/doc/classes/HSlider.xml index be22635e355..12d228c59e4 100644 --- a/doc/classes/HSlider.xml +++ b/doc/classes/HSlider.xml @@ -17,22 +17,22 @@ The texture for the grabber (the draggable element). - - The background of the area to the left of the grabber. - - - The texture for the grabber when it's disabled. The texture for the grabber when it's focused. - - The background for the whole slider. Determines the height of the [code]grabber_area[/code]. - The texture for the ticks, visible when [member Slider.tick_count] is greater than 0. + + The background of the area to the left of the grabber. + + + + + The background for the whole slider. Determines the height of the [code]grabber_area[/code]. + diff --git a/doc/classes/HSplitContainer.xml b/doc/classes/HSplitContainer.xml index bfc216a739a..6f61ae74986 100644 --- a/doc/classes/HSplitContainer.xml +++ b/doc/classes/HSplitContainer.xml @@ -16,13 +16,13 @@ Boolean value. If 1 ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If 0 ([code]false[/code]), it's always visible. - + + The space between sides of the container. The icon used for the grabber drawn in the middle area. - - The space between sides of the container. + diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 0e9fce82bef..729ff3186e4 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -408,21 +408,6 @@ - - Default [StyleBox] for the [ItemList], i.e. used when the control is not being focused. - - - [StyleBox] used when the [ItemList] is being focused. - - - [StyleBox] used for the cursor, when the [ItemList] is being focused. - - - [StyleBox] used for the cursor, when the [ItemList] is not being focused. - - - [Font] of the item's text. - Default text [Color] of the item. @@ -441,14 +426,29 @@ The vertical spacing between each line of text. + + The vertical spacing between items. + + + [Font] of the item's text. + + + Default [StyleBox] for the [ItemList], i.e. used when the control is not being focused. + + + [StyleBox] used when the [ItemList] is being focused. + + + [StyleBox] used for the cursor, when the [ItemList] is being focused. + + + [StyleBox] used for the cursor, when the [ItemList] is not being focused. + [StyleBox] for the selected items, used when the [ItemList] is not being focused. [StyleBox] for the selected items, used when the [ItemList] is being focused. - - The vertical spacing between items. - diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index b6e639254e8..cd35820cff2 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -98,9 +98,6 @@ - - [Font] used for the [Label]'s text. - Default text [Color] of the [Label]. @@ -113,9 +110,6 @@ Vertical space between lines in multiline [Label]. - - Background [StyleBox] for the [Label]. - Boolean value. If set to 1 ([code]true[/code]), the shadow will be displayed around the whole text as an outline. @@ -125,5 +119,11 @@ The vertical offset of the text's shadow. + + [Font] used for the [Label]'s text. + + + Background [StyleBox] for the [Label]. + diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 7bb84f053e3..377fa579189 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -232,9 +232,6 @@ - - Texture for the clear button. See [member clear_button_enabled]. - Color used as default tint for the clear button. @@ -244,12 +241,6 @@ Color of the [LineEdit]'s visual cursor (caret). - - Background used when [LineEdit] has GUI focus. - - - Font used for the text. - Default font color. @@ -259,17 +250,26 @@ Font color when editing is disabled. + + Color of the selection rectangle. + Minimum horizontal space for the text (not counting the clear button and content margins). This value is measured in count of space characters (i.e. this amount of space characters can be displayed without scrolling). + + Font used for the text. + + + Texture for the clear button. See [member clear_button_enabled]. + + + Background used when [LineEdit] has GUI focus. + Default background for the [LineEdit]. Background used when [LineEdit] is in read-only mode ([member editable] is set to [code]false[/code]). - - Color of the selection rectangle. - diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index 64e5692969b..7e253118b02 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -33,12 +33,6 @@ - - [StyleBox] used when the [LinkButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. - - - [Font] of the [LinkButton]'s text. - Default text [Color] of the [LinkButton]. @@ -54,5 +48,11 @@ The vertical space between the baseline of text and the underline. + + [Font] of the [LinkButton]'s text. + + + [StyleBox] used when the [LinkButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. + diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 72c985672fb..6abbe8988f1 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -45,15 +45,6 @@ - - [StyleBox] used when the [MenuButton] is disabled. - - - [StyleBox] used when the [MenuButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. - - - [Font] of the [MenuButton]'s text. - Default text [Color] of the [MenuButton]. @@ -69,12 +60,21 @@ Text [Color] used when the [MenuButton] is being pressed. - - [StyleBox] used when the [MenuButton] is being hovered. - The horizontal space between [MenuButton]'s icon and text. + + [Font] of the [MenuButton]'s text. + + + [StyleBox] used when the [MenuButton] is disabled. + + + [StyleBox] used when the [MenuButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. + + + [StyleBox] used when the [MenuButton] is being hovered. + Default [StyleBox] for the [MenuButton]. diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 372bac360c5..f28cb73ec40 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -187,21 +187,6 @@ - - The arrow icon to be drawn on the right end of the button. - - - The horizontal space between the arrow icon and the right edge of the button. - - - [StyleBox] used when the [OptionButton] is disabled. - - - [StyleBox] used when the [OptionButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. - - - [Font] of the [OptionButton]'s text. - Default text [Color] of the [OptionButton]. @@ -217,12 +202,27 @@ Text [Color] used when the [OptionButton] is being pressed. - - [StyleBox] used when the [OptionButton] is being hovered. + + The horizontal space between the arrow icon and the right edge of the button. The horizontal space between [OptionButton]'s icon and text. + + [Font] of the [OptionButton]'s text. + + + The arrow icon to be drawn on the right end of the button. + + + [StyleBox] used when the [OptionButton] is disabled. + + + [StyleBox] used when the [OptionButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. + + + [StyleBox] used when the [OptionButton] is being hovered. + Default [StyleBox] for the [OptionButton]. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 266fec66ad1..fd2e595ce46 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -496,12 +496,6 @@ - - [Texture] icon for the checked checkbox items. - - - [Font] used for the menu items. - The default text [Color] for menu items' names. @@ -517,12 +511,33 @@ [Color] used for labeled separators' text. See [method add_separator]. - - [StyleBox] displayed when the [PopupMenu] item is hovered. - The horizontal space between the item's name and the shortcut text/submenu arrow. + + The vertical space between each menu item. + + + [Font] used for the menu items. + + + [Texture] icon for the checked checkbox items. + + + [Texture] icon for the checked radio button items. + + + [Texture] icon for the unchecked radio button items. + + + [Texture] icon for the submenu arrow. + + + [Texture] icon for the unchecked checkbox items. + + + [StyleBox] displayed when the [PopupMenu] item is hovered. + [StyleBox] for the left side of labeled separator. See [method add_separator]. @@ -535,23 +550,8 @@ [StyleBox] used when the [PopupMenu] item is disabled. - - [Texture] icon for the checked radio button items. - - - [Texture] icon for the unchecked radio button items. - [StyleBox] used for the separators. See [method add_separator]. - - [Texture] icon for the submenu arrow. - - - [Texture] icon for the unchecked checkbox items. - - - The vertical space between each menu item. - diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml index 8285a256e3a..bbe216567f2 100644 --- a/doc/classes/ProgressBar.xml +++ b/doc/classes/ProgressBar.xml @@ -20,20 +20,20 @@ - - The style of the background. - - - The style of the progress (i.e. the part that fills the bar). - - - Font used to draw the fill percentage if [member percent_visible] is [code]true[/code]. - The color of the text. The color of the text's shadow. + + Font used to draw the fill percentage if [member percent_visible] is [code]true[/code]. + + + The style of the background. + + + The style of the progress (i.e. the part that fills the bar). + diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 81151f854db..dad9770a3b6 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -367,42 +367,21 @@ - - The font used for bold text. - - - The font used for bold italics text. - The default text color. - - The background The background used when the [RichTextLabel] is focused. - The color of selected text, used when [member selection_enabled] is [code]true[/code]. The color of the font's shadow. - - The font used for italics text. + + The color of the selection box. The vertical space between lines. - - The font used for monospace text. - - - The normal background for the [RichTextLabel]. - - - The default text font. - - - The color of the selection box. - Boolean value. If 1 ([code]true[/code]), the shadow will be displayed around the whole text as an outline. @@ -418,5 +397,26 @@ The vertical separation of elements in a table. + + The font used for bold text. + + + The font used for bold italics text. + + + The font used for italics text. + + + The font used for monospace text. + + + The default text font. + + + The background The background used when the [RichTextLabel] is focused. + + + The normal background for the [RichTextLabel]. + diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 6b86b8b9370..4678176a955 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -182,15 +182,6 @@ - - Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent. - - - Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. - - - The font used to draw tab names. - Font color of inactive tabs. @@ -203,16 +194,30 @@ Horizontal separation between tabs. + + + + + + The space at the left and right edges of the tab bar. + + + + + The font used to draw tab names. + + + Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent. + + + Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. + Icon for the right arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent. Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. - - - - The icon for the menu button (see [method set_popup]). @@ -222,9 +227,6 @@ The style for the background fill. - - The space at the left and right edges of the tab bar. - The style of inactive tabs. @@ -234,7 +236,5 @@ The style of the currently selected tab. - - diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index a61fa777cd3..9ca51df5f7e 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -224,24 +224,6 @@ - - Background of the close button when it's being hovered with the cursor. - - - Background of the close button when it's being pressed. - - - The icon for the close button (see [member tab_close_display_policy]). - - - Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent. - - - Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. - - - The font used to draw tab names. - Font color of inactive tabs. @@ -254,15 +236,35 @@ The horizontal separation between the tabs. + + + + + + + + The font used to draw tab names. + + + The icon for the close button (see [member tab_close_display_policy]). + + + Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent. + + + Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. + Icon for the right arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent. Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. - + + Background of the close button when it's being hovered with the cursor. - + + Background of the close button when it's being pressed. The style of an inactive tab. @@ -273,7 +275,5 @@ The style of the currently selected tab. - - diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index f3048759b10..e3083004a9d 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -635,22 +635,14 @@ - - - - - - - - @@ -658,15 +650,6 @@ - - - - - - - - Sets the default [Font]. - Sets the font [Color]. @@ -680,36 +663,53 @@ Sets the [Color] of the line numbers. [member show_line_numbers] has to be enabled. - - Sets the spacing between the lines. - Sets the [Color] of marked text. - - Sets the [StyleBox] of this [TextEdit]. - - - Sets the [StyleBox] of this [TextEdit] when [member readonly] is enabled. - Sets the highlight [Color] of text selections. - - - - Sets a custom [Texture] for tab text characters. - Sets the highlight [Color] of multiple occurrences. [member highlight_all_occurrences] has to be enabled. + + + + + + + + Sets the spacing between the lines. + + + Sets the default [Font]. + + + + + + + + + Sets a custom [Texture] for tab text characters. + + + + + + + Sets the [StyleBox] of this [TextEdit]. + + + Sets the [StyleBox] of this [TextEdit] when [member readonly] is enabled. + diff --git a/doc/classes/ToolButton.xml b/doc/classes/ToolButton.xml index f7075d3e721..2d2f3bb7533 100644 --- a/doc/classes/ToolButton.xml +++ b/doc/classes/ToolButton.xml @@ -20,15 +20,6 @@ - - [StyleBox] used when the [ToolButton] is disabled. - - - [StyleBox] used when the [ToolButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. - - - [Font] of the [ToolButton]'s text. - Default text [Color] of the [ToolButton]. @@ -44,12 +35,21 @@ Text [Color] used when the [ToolButton] is being pressed. - - [StyleBox] used when the [ToolButton] is being hovered. - The horizontal space between [ToolButton]'s icon and text. + + [Font] of the [ToolButton]'s text. + + + [StyleBox] used when the [ToolButton] is disabled. + + + [StyleBox] used when the [ToolButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect. + + + [StyleBox] used when the [ToolButton] is being hovered. + Default [StyleBox] for the [ToolButton]. diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 096ecf2653c..b57d3ef045c 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -355,57 +355,12 @@ - - The arrow icon used when a foldable item is not collapsed. - - - The arrow icon used when a foldable item is collapsed. - - - Default [StyleBox] for the [Tree], i.e. used when the control is not being focused. - - - [StyleBox] used when the [Tree] is being focused. - - - The horizontal space between each button in a cell. - - - [StyleBox] used when a button in the tree is pressed. - - - The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is checked. - - - [StyleBox] used for the cursor, when the [Tree] is being focused. - - - [StyleBox] used for the cursor, when the [Tree] is not being focused. - - - Default [StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell. - Text [Color] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell when it's hovered. - - [StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell when it's hovered. - - - [StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell when it's pressed. - - - Draws the guidelines if not zero, this acts as a boolean. The guideline is a horizontal line drawn at the bottom of each item. - - - Draws the relationship lines if not zero, this acts as a boolean. Relationship lines are drawn at the start of child items to show hierarchy. - [Color] used to draw possible drop locations. See [enum DropModeFlags] constants for further description of drop locations. - - [Font] of the item's text. - Default text [Color] of the item. @@ -415,36 +370,90 @@ [Color] of the guideline. + + [Color] of the relationship lines. + + + Default text [Color] of the title button. + + + The horizontal space between each button in a cell. + + + Draws the guidelines if not zero, this acts as a boolean. The guideline is a horizontal line drawn at the bottom of each item. + + + Draws the relationship lines if not zero, this acts as a boolean. Relationship lines are drawn at the start of child items to show hierarchy. + The horizontal space between item cells. This is also used as the margin at the start of an item when folding is disabled. The horizontal margin at the start of an item. This is used when folding is enabled for the item. - - [Color] of the relationship lines. - The maximum distance between the mouse cursor and the control's border to trigger border scrolling when dragging. The speed of border scrolling. + + The vertical padding inside each item, i.e. the distance between the item's content and top/bottom border. + + + [Font] of the item's text. + + + [Font] of the title button's text. + + + The arrow icon used when a foldable item is not collapsed. + + + The arrow icon used when a foldable item is collapsed. + + + The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is checked. + The arrow icon to display for the [constant TreeItem.CELL_MODE_RANGE] mode cell. + + The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is unchecked. + + + The updown arrow icon to display for the [constant TreeItem.CELL_MODE_RANGE] mode cell. + + + Default [StyleBox] for the [Tree], i.e. used when the control is not being focused. + + + [StyleBox] used when the [Tree] is being focused. + + + [StyleBox] used when a button in the tree is pressed. + + + [StyleBox] used for the cursor, when the [Tree] is being focused. + + + [StyleBox] used for the cursor, when the [Tree] is not being focused. + + + Default [StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell. + + + [StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell when it's hovered. + + + [StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell when it's pressed. + [StyleBox] for the selected items, used when the [Tree] is not being focused. [StyleBox] for the selected items, used when the [Tree] is being focused. - - Default text [Color] of the title button. - - - [Font] of the title button's text. - [StyleBox] used when the title button is being hovered. @@ -454,14 +463,5 @@ [StyleBox] used when the title button is being pressed. - - The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is unchecked. - - - The updown arrow icon to display for the [constant TreeItem.CELL_MODE_RANGE] mode cell. - - - The vertical padding inside each item, i.e. the distance between the item's content and top/bottom border. - diff --git a/doc/classes/VScrollBar.xml b/doc/classes/VScrollBar.xml index 809793cbb1b..8a432442eb0 100644 --- a/doc/classes/VScrollBar.xml +++ b/doc/classes/VScrollBar.xml @@ -26,15 +26,6 @@ Displayed when the decrement button is being pressed. - - Used as texture for the grabber, the draggable element representing current scroll. - - - Used when the mouse hovers over the grabber. - - - Used when the grabber is being dragged. - Icon used as a button to scroll the [ScrollBar] down. Supports custom step using the [member ScrollBar.custom_step] property. @@ -44,6 +35,15 @@ Displayed when the increment button is being pressed. + + Used as texture for the grabber, the draggable element representing current scroll. + + + Used when the mouse hovers over the grabber. + + + Used when the grabber is being dragged. + Used as background of this [ScrollBar]. diff --git a/doc/classes/VSlider.xml b/doc/classes/VSlider.xml index e5b5f738a55..9c640a1b291 100644 --- a/doc/classes/VSlider.xml +++ b/doc/classes/VSlider.xml @@ -21,22 +21,22 @@ The texture for the grabber (the draggable element). - - The background of the area below the grabber. - - - The texture for the grabber when it's disabled. The texture for the grabber when it's focused. - - The background for the whole slider. Determines the width of the [code]grabber_area[/code]. - The texture for the ticks, visible when [member Slider.tick_count] is greater than 0. + + The background of the area below the grabber. + + + + + The background for the whole slider. Determines the width of the [code]grabber_area[/code]. + diff --git a/doc/classes/VSplitContainer.xml b/doc/classes/VSplitContainer.xml index 2629cab1497..13e2009055a 100644 --- a/doc/classes/VSplitContainer.xml +++ b/doc/classes/VSplitContainer.xml @@ -16,13 +16,13 @@ Boolean value. If 1 ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If 0 ([code]false[/code]), it's always visible. - + + The space between sides of the container. The icon used for the grabber drawn in the middle area. - - The space between sides of the container. + diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index f41ec9f9745..7ff955f924c 100644 --- a/doc/classes/WindowDialog.xml +++ b/doc/classes/WindowDialog.xml @@ -28,32 +28,32 @@ - - The icon for the close button. + + The color of the title text. The horizontal offset of the close button. - - The icon used for the close button when it's hovered with the mouse cursor. - The vertical offset of the close button. - - The style for both the content background of the [WindowDialog] and the title bar. The title bar is created with a top border and an expand margin using the [code]panel[/code] stylebox. - The thickness of the border that can be dragged when scaling the window (if [member resizable] is enabled). - - The color of the title text. + + The vertical offset of the title text. The font used to draw the title. - - The vertical offset of the title text. + + The icon for the close button. + + + The icon used for the close button when it's hovered with the mouse cursor. + + + The style for both the content background of the [WindowDialog] and the title bar. The title bar is created with a top border and an expand margin using the [code]panel[/code] stylebox. diff --git a/editor/doc/doc_data.cpp b/editor/doc/doc_data.cpp index 0cd03bc7214..20eae0a8c58 100644 --- a/editor/doc/doc_data.cpp +++ b/editor/doc/doc_data.cpp @@ -511,6 +511,8 @@ void DocData::generate(bool p_basic_types) { tid.data_type = "style"; c.theme_properties.push_back(tid); } + + c.theme_properties.sort(); } classes.pop_front(); diff --git a/editor/doc/doc_data.h b/editor/doc/doc_data.h index e227968e75c..fb40b8072ec 100644 --- a/editor/doc/doc_data.h +++ b/editor/doc/doc_data.h @@ -87,7 +87,11 @@ public: String description; String default_value; bool operator<(const ThemeItemDoc &p_theme_item) const { - return name < p_theme_item.name; + // First sort by the data type, then by name. + if (data_type == p_theme_item.data_type) { + return name < p_theme_item.name; + } + return data_type < p_theme_item.data_type; } }; diff --git a/editor/editor_help.cpp b/editor/editor_help.cpp index 02c04ea95ce..e99db73d403 100644 --- a/editor/editor_help.cpp +++ b/editor/editor_help.cpp @@ -233,8 +233,7 @@ void EditorHelp::_add_method(const DocData::MethodDoc &p_method, bool p_overview class_desc->push_cell(); class_desc->push_align(RichTextLabel::ALIGN_RIGHT); } else { - static const CharType prefix[3] = { 0x25CF /* filled circle */, ' ', 0 }; - class_desc->add_text(String(prefix)); + _add_bulletpoint(); } _add_type(p_method.return_type, p_method.return_enum); @@ -310,6 +309,11 @@ void EditorHelp::_add_method(const DocData::MethodDoc &p_method, bool p_overview } } +void EditorHelp::_add_bulletpoint() { + static const CharType prefix[3] = { 0x25CF /* filled circle */, ' ', 0 }; + class_desc->add_text(String(prefix)); +} + Error EditorHelp::_goto_desc(const String &p_class, int p_vscr) { if (!doc->class_list.has(p_class)) { return ERR_DOES_NOT_EXIST; @@ -676,27 +680,53 @@ void EditorHelp::_update_doc() { class_desc->pop(); class_desc->pop(); + class_desc->add_newline(); + class_desc->add_newline(); + class_desc->push_indent(1); - class_desc->push_table(2); - class_desc->set_table_column_expand(1, true); + + String theme_data_type; + Map data_type_names; + data_type_names["color"] = TTR("Colors"); + data_type_names["constant"] = TTR("Constants"); + data_type_names["font"] = TTR("Fonts"); + data_type_names["icon"] = TTR("Icons"); + data_type_names["style"] = TTR("Styles"); for (int i = 0; i < cd.theme_properties.size(); i++) { theme_property_line[cd.theme_properties[i].name] = class_desc->get_line_count() - 2; //gets overridden if description - class_desc->push_cell(); - class_desc->push_align(RichTextLabel::ALIGN_RIGHT); - class_desc->push_font(doc_code_font); - _add_type(cd.theme_properties[i].type); - class_desc->pop(); - class_desc->pop(); - class_desc->pop(); + if (theme_data_type != cd.theme_properties[i].data_type) { + theme_data_type = cd.theme_properties[i].data_type; - class_desc->push_cell(); + class_desc->push_color(title_color); + class_desc->push_font(doc_bold_font); + if (data_type_names.has(theme_data_type)) { + class_desc->add_text(data_type_names[theme_data_type]); + } else { + class_desc->add_text(""); + } + class_desc->pop(); + class_desc->pop(); + + class_desc->add_newline(); + class_desc->add_newline(); + } + + // Theme item header. class_desc->push_font(doc_code_font); + _add_bulletpoint(); + + // Theme item object type. + _add_type(cd.theme_properties[i].type); + + // Theme item name. class_desc->push_color(headline_color); + class_desc->add_text(" "); _add_text(cd.theme_properties[i].name); class_desc->pop(); + // Theme item default value. if (cd.theme_properties[i].default_value != "") { class_desc->push_color(symbol_color); class_desc->add_text(" [" + TTR("default:") + " "); @@ -709,23 +739,25 @@ void EditorHelp::_update_doc() { class_desc->pop(); } - class_desc->pop(); + class_desc->pop(); // monofont + // Theme item description. if (cd.theme_properties[i].description != "") { class_desc->push_font(doc_font); - class_desc->add_text(" "); class_desc->push_color(comment_color); + class_desc->push_indent(1); _add_text(DTR(cd.theme_properties[i].description)); - class_desc->pop(); - class_desc->pop(); + class_desc->pop(); // indent + class_desc->pop(); // color + class_desc->pop(); // font } - class_desc->pop(); // cell + + class_desc->add_newline(); + class_desc->add_newline(); } - class_desc->pop(); // table class_desc->pop(); class_desc->add_newline(); - class_desc->add_newline(); } // Signals @@ -748,10 +780,10 @@ void EditorHelp::_update_doc() { for (int i = 0; i < cd.signals.size(); i++) { signal_line[cd.signals[i].name] = class_desc->get_line_count() - 2; //gets overridden if description + class_desc->push_font(doc_code_font); // monofont class_desc->push_color(headline_color); - static const CharType prefix[3] = { 0x25CF /* filled circle */, ' ', 0 }; - class_desc->add_text(String(prefix)); + _add_bulletpoint(); _add_text(cd.signals[i].name); class_desc->pop(); class_desc->push_color(symbol_color); @@ -865,8 +897,7 @@ void EditorHelp::_update_doc() { class_desc->push_font(doc_code_font); class_desc->push_color(headline_color); - static const CharType prefix[3] = { 0x25CF /* filled circle */, ' ', 0 }; - class_desc->add_text(String(prefix)); + _add_bulletpoint(); _add_text(enum_list[i].name); class_desc->pop(); class_desc->push_color(symbol_color); @@ -876,11 +907,12 @@ void EditorHelp::_update_doc() { _add_text(_fix_constant(enum_list[i].value)); class_desc->pop(); class_desc->pop(); - if (enum_list[i].description != "") { + + class_desc->add_newline(); + + if (enum_list[i].description.strip_edges() != "") { class_desc->push_font(doc_font); class_desc->push_color(comment_color); - static const CharType dash[6] = { ' ', ' ', 0x2013 /* en dash */, ' ', ' ', 0 }; - class_desc->add_text(String(dash)); _add_text(DTR(enum_list[i].description)); class_desc->pop(); class_desc->pop(); @@ -926,13 +958,11 @@ void EditorHelp::_update_doc() { Vector color = stripped.split_floats(","); if (color.size() >= 3) { class_desc->push_color(Color(color[0], color[1], color[2])); - static const CharType prefix[3] = { 0x25CF /* filled circle */, ' ', 0 }; - class_desc->add_text(String(prefix)); + _add_bulletpoint(); class_desc->pop(); } } else { - static const CharType prefix[3] = { 0x25CF /* filled circle */, ' ', 0 }; - class_desc->add_text(String(prefix)); + _add_bulletpoint(); } class_desc->push_color(headline_color); @@ -946,11 +976,12 @@ void EditorHelp::_update_doc() { class_desc->pop(); class_desc->pop(); + + class_desc->add_newline(); + if (constants[i].description != "") { class_desc->push_font(doc_font); class_desc->push_color(comment_color); - static const CharType dash[6] = { ' ', ' ', 0x2013 /* en dash */, ' ', ' ', 0 }; - class_desc->add_text(String(dash)); _add_text(DTR(constants[i].description)); class_desc->pop(); class_desc->pop(); @@ -991,8 +1022,7 @@ void EditorHelp::_update_doc() { class_desc->push_cell(); class_desc->push_font(doc_code_font); - static const CharType prefix[3] = { 0x25CF /* filled circle */, ' ', 0 }; - class_desc->add_text(String(prefix)); + _add_bulletpoint(); _add_type(cd.properties[i].type, cd.properties[i].enumeration); class_desc->add_text(" "); diff --git a/editor/editor_help.h b/editor/editor_help.h index 442ff884d5e..d2bc99e5e93 100644 --- a/editor/editor_help.h +++ b/editor/editor_help.h @@ -147,6 +147,8 @@ class EditorHelp : public VBoxContainer { void _add_type(const String &p_type, const String &p_enum = String()); void _add_method(const DocData::MethodDoc &p_method, bool p_overview = true); + void _add_bulletpoint(); + void _class_list_select(const String &p_select); void _class_desc_select(const String &p_select); void _class_desc_input(const Ref &p_input);