From 21dd35b611e71d0b07fe9ee9d764869e6671795a Mon Sep 17 00:00:00 2001 From: Tomasz Chabora Date: Mon, 27 Jan 2020 02:15:37 +0100 Subject: [PATCH] Document theme_items of multiple classes --- doc/classes/Button.xml | 11 +++++++++++ doc/classes/HBoxContainer.xml | 1 + doc/classes/Label.xml | 9 +++++++++ doc/classes/PopupMenu.xml | 33 ++++++++++++++++++--------------- doc/classes/ScrollContainer.xml | 1 + doc/classes/ToolButton.xml | 11 +++++++++++ doc/classes/VBoxContainer.xml | 1 + 7 files changed, 52 insertions(+), 15 deletions(-) diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index 34ad2bd8226..ac2b77f40eb 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -43,26 +43,37 @@ + [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]. + Text [Color] used when the [Button] is disabled. + Text [Color] used when the [Button] is being hovered. + 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. + Default [StyleBox] for the [Button]. + [StyleBox] used when the [Button] is being pressed. diff --git a/doc/classes/HBoxContainer.xml b/doc/classes/HBoxContainer.xml index 714fecc5da5..d3456c99a9b 100644 --- a/doc/classes/HBoxContainer.xml +++ b/doc/classes/HBoxContainer.xml @@ -14,6 +14,7 @@ + The horizontal space between the [HBoxContainer]'s elements. diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 30f08220a2a..125f7b5a2ec 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -101,22 +101,31 @@ + [Font] used for the [Label]'s text. + Default text [Color] of the [Label]. + [Color] of the text's shadow effect. + The tint of [Font]'s outline. See [member DynamicFont.outline_color]. + 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. + The horizontal offset of the text's shadow. + The vertical offset of the text's shadow. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 9289f500e92..25b38d07ed3 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -645,55 +645,58 @@ - Sets a custom [Texture] icon for [code]checked[/code] state of checkbox items. + [Texture] icon for the checked checkbox items. - Sets a custom [Font]. + [Font] used for the menu items. - Sets a custom [Color] for the [Font]. + The default text [Color] for menu items' names. + The text [Color] used for shortcuts and accelerators that show next to the menu item name when defined. See [method get_item_accelerator] for more info on accelerators. - Sets a custom [Color] for disabled text. + [Color] used for disabled menu items' text. - Sets a custom [Color] for the hovered text. + [Color] used for the hovered text. - Sets a custom [StyleBox] when the [PopupMenu] is hovered. + [StyleBox] displayed when the [PopupMenu] item is hovered. - Sets the horizontal space separation between each item. + The horizontal space between the item's name and the shortcut text/submenu arrow. + [StyleBox] for the left side of labeled separator. See [method add_separator]. + [StyleBox] for the right side of labeled separator. See [method add_separator]. - Sets a custom [StyleBox] for the panel of the [PopupMenu]. + Default [StyleBox] of the [PopupMenu] items. - Sets a custom [StyleBox] for the panel of the [PopupMenu], when the panel is disabled. + [StyleBox] used when the [PopupMenu] item is disabled. - Sets a custom [Texture] icon for [code]checked[/code] of radio button items. + [Texture] icon for the checked radio button items. - Sets a custom [Texture] icon for [code]unchecked[/code] of radio button items. + [Texture] icon for the unchecked radio button items. - Sets a custom [StyleBox] for separator's. + [StyleBox] used for the separators. See [method add_separator]. - Sets a custom [Texture] for submenu's. + [Texture] icon for the submenu arrow. - Sets a custom [Texture] icon for [code]unchecked[/code] of checkbox items. + [Texture] icon for the unchecked checkbox items. - Sets the vertical space separation between each item. + The vertical space between each menu item. diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 590dc4cc31b..1ba097fb516 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -60,6 +60,7 @@ + The background [StyleBox] of the [ScrollContainer]. diff --git a/doc/classes/ToolButton.xml b/doc/classes/ToolButton.xml index d81cbb18f72..6a5ab52608b 100644 --- a/doc/classes/ToolButton.xml +++ b/doc/classes/ToolButton.xml @@ -21,26 +21,37 @@ + [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]. + Text [Color] used when the [ToolButton] is disabled. + Text [Color] used when the [ToolButton] is being hovered. + 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. + Default [StyleBox] for the [ToolButton]. + [StyleBox] used when the [ToolButton] is being pressed. diff --git a/doc/classes/VBoxContainer.xml b/doc/classes/VBoxContainer.xml index b944ead7cda..2b7dc90149b 100644 --- a/doc/classes/VBoxContainer.xml +++ b/doc/classes/VBoxContainer.xml @@ -14,6 +14,7 @@ + The vertical space between the [VBoxContainer]'s elements.