diff options
Diffstat (limited to 'doc/classes/MenuButton.xml')
| -rw-r--r-- | doc/classes/MenuButton.xml | 76 |
1 files changed, 39 insertions, 37 deletions
diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 7cbf9d3dfe..bec567b3ef 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MenuButton" inherits="Button" version="4.0"> +<class name="MenuButton" inherits="Button" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Special button that brings up a [PopupMenu] when clicked. </brief_description> @@ -12,30 +12,31 @@ </tutorials> <methods> <method name="get_popup" qualifiers="const"> - <return type="PopupMenu"> - </return> + <return type="PopupMenu" /> <description> Returns the [PopupMenu] contained in this button. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="set_disable_shortcuts"> - <return type="void"> - </return> - <argument index="0" name="disabled" type="bool"> - </argument> + <return type="void" /> + <argument index="0" name="disabled" type="bool" /> <description> If [code]true[/code], shortcuts are disabled and cannot be used to trigger the button. </description> </method> </methods> <members> - <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" override="true" enum="BaseButton.ActionMode" default="0" /> - <member name="flat" type="bool" setter="set_flat" getter="is_flat" override="true" default="true" /> - <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="0" /> + <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" overrides="BaseButton" enum="BaseButton.ActionMode" default="0" /> + <member name="flat" type="bool" setter="set_flat" getter="is_flat" overrides="Button" default="true" /> + <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="0" /> + <member name="item_count" type="int" setter="set_item_count" getter="get_item_count" default="0"> + The number of items currently in the list. + </member> <member name="switch_on_hover" type="bool" setter="set_switch_on_hover" getter="is_switch_on_hover" default="false"> If [code]true[/code], when the cursor hovers above another [MenuButton] within the same parent which also has [code]switch_on_hover[/code] enabled, it will close the current [MenuButton] and open the other one. </member> - <member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" override="true" default="true" /> + <member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" overrides="BaseButton" default="true" /> </members> <signals> <signal name="about_to_popup"> @@ -44,49 +45,50 @@ </description> </signal> </signals> - <constants> - </constants> <theme_items> - <theme_item name="disabled" type="StyleBox"> - [StyleBox] used when the [MenuButton] is disabled. - </theme_item> - <theme_item name="focus" type="StyleBox"> - [StyleBox] used when the [MenuButton] 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" type="Font"> - [Font] of the [MenuButton]'s 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.875, 0.875, 0.875, 1)"> Default text [Color] of the [MenuButton]. </theme_item> - <theme_item name="font_disabled_color" type="Color" default="Color( 1, 1, 1, 0.3 )"> + <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(1, 1, 1, 0.3)"> Text [Color] used when the [MenuButton] is disabled. </theme_item> - <theme_item name="font_hover_color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )"> + <theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)"> + Text [Color] used when the [MenuButton] is focused. Only replaces the normal text color of the button. 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)"> Text [Color] used when the [MenuButton] is being hovered. </theme_item> - <theme_item name="font_outline_color" 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 [MenuButton]. </theme_item> - <theme_item name="font_pressed_color" type="Color" default="Color( 1, 1, 1, 1 )"> + <theme_item name="font_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> Text [Color] used when the [MenuButton] is being pressed. </theme_item> - <theme_item name="font_size" type="int"> + <theme_item name="h_separation" data_type="constant" type="int" default="3"> + The horizontal space between [MenuButton]'s icon and text. + </theme_item> + <theme_item name="outline_size" data_type="constant" type="int" default="0"> + The size of the text outline. + </theme_item> + <theme_item name="font" data_type="font" type="Font"> + [Font] of the [MenuButton]'s text. + </theme_item> + <theme_item name="font_size" data_type="font_size" type="int"> Font size of the [MenuButton]'s text. </theme_item> - <theme_item name="hover" type="StyleBox"> - [StyleBox] used when the [MenuButton] is being hovered. + <theme_item name="disabled" data_type="style" type="StyleBox"> + [StyleBox] used when the [MenuButton] is disabled. </theme_item> - <theme_item name="hseparation" type="int" default="3"> - The horizontal space between [MenuButton]'s icon and text. + <theme_item name="focus" data_type="style" type="StyleBox"> + [StyleBox] used when the [MenuButton] 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="normal" type="StyleBox"> - Default [StyleBox] for the [MenuButton]. + <theme_item name="hover" data_type="style" type="StyleBox"> + [StyleBox] used when the [MenuButton] is being hovered. </theme_item> - <theme_item name="outline_size" type="int" default="0"> - The size of the text outline. + <theme_item name="normal" data_type="style" type="StyleBox"> + Default [StyleBox] for the [MenuButton]. </theme_item> - <theme_item name="pressed" type="StyleBox"> + <theme_item name="pressed" data_type="style" type="StyleBox"> [StyleBox] used when the [MenuButton] is being pressed. </theme_item> </theme_items> |