2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 02:03:48 +01:00
<class name= "MenuButton" inherits= "Button" version= "4.0" >
2017-09-12 22:42:36 +02:00
<brief_description >
Special button that brings up a [PopupMenu] when clicked.
</brief_description>
<description >
2020-01-23 11:14:14 +01:00
Special button that brings up a [PopupMenu] when clicked.
2021-03-18 12:04:28 +01:00
New items can be created inside this [PopupMenu] using [code]get_popup().add_item("My Item Name")[/code]. You can also create them directly from the editor. To do so, select the [MenuButton] node, then in the toolbar at the top of the 2D editor, click [b]Items[/b] then click [b]Add[/b] in the popup. You will be able to give each item new properties.
2020-09-23 23:34:28 +02:00
See also [BaseButton] which contains common properties and methods associated with this node.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
2017-12-25 17:03:53 +01:00
<method name= "get_popup" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "PopupMenu" />
2017-09-12 22:42:36 +02:00
<description >
2019-05-24 04:15:43 +02:00
Returns the [PopupMenu] contained in this button.
2021-10-10 21:28:56 +02:00
[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.
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-01-03 13:45:03 +01:00
<method name= "set_disable_shortcuts" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "disabled" type= "bool" />
2018-01-03 13:45:03 +01:00
<description >
2020-01-23 11:14:14 +01:00
If [code]true[/code], shortcuts are disabled and cannot be used to trigger the button.
2018-01-03 13:45:03 +01:00
</description>
</method>
2017-09-12 22:42:36 +02:00
</methods>
2018-07-30 00:26:43 +02:00
<members >
2019-09-24 13:34:03 +02:00
<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" />
2020-12-04 15:54:48 +01:00
<member name= "focus_mode" type= "int" setter= "set_focus_mode" getter= "get_focus_mode" override= "true" enum= "Control.FocusMode" default= "0" />
2019-06-29 12:38:01 +02:00
<member name= "switch_on_hover" type= "bool" setter= "set_switch_on_hover" getter= "is_switch_on_hover" default= "false" >
2020-01-23 11:14:14 +01:00
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.
2018-07-30 00:26:43 +02:00
</member>
2019-09-24 13:34:03 +02:00
<member name= "toggle_mode" type= "bool" setter= "set_toggle_mode" getter= "is_toggle_mode" override= "true" default= "true" />
2018-07-30 00:26:43 +02:00
</members>
2017-09-12 22:42:36 +02:00
<signals >
2020-03-31 11:56:58 +02:00
<signal name= "about_to_popup" >
2017-09-12 22:42:36 +02:00
<description >
2020-03-31 11:56:58 +02:00
Emitted when the [PopupMenu] of this MenuButton is about to show.
2017-09-12 22:42:36 +02:00
</description>
</signal>
</signals>
<theme_items >
2021-08-04 18:54:41 +02:00
<theme_item name= "disabled" data_type= "style" type= "StyleBox" >
2020-02-04 08:46:01 +01:00
[StyleBox] used when the [MenuButton] is disabled.
2017-09-12 22:42:36 +02:00
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "focus" data_type= "style" type= "StyleBox" >
2020-02-04 08:46:01 +01:00
[StyleBox] used when the [MenuButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
2017-09-12 22:42:36 +02:00
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "font" data_type= "font" type= "Font" >
2020-02-04 08:46:01 +01:00
[Font] of the [MenuButton]'s text.
2017-09-12 22:42:36 +02:00
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "font_color" data_type= "color" type= "Color" default= "Color(0.88, 0.88, 0.88, 1)" >
2020-02-04 08:46:01 +01:00
Default text [Color] of the [MenuButton].
2017-09-12 22:42:36 +02:00
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "font_disabled_color" data_type= "color" type= "Color" default= "Color(1, 1, 1, 0.3)" >
2020-02-04 08:46:01 +01:00
Text [Color] used when the [MenuButton] is disabled.
2017-09-12 22:42:36 +02:00
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "font_hover_color" data_type= "color" type= "Color" default= "Color(0.94, 0.94, 0.94, 1)" >
2020-02-04 08:46:01 +01:00
Text [Color] used when the [MenuButton] is being hovered.
2017-09-12 22:42:36 +02:00
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "font_outline_color" data_type= "color" type= "Color" default= "Color(1, 1, 1, 1)" >
2020-12-25 22:45:28 +01:00
The tint of text outline of the [MenuButton].
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "font_pressed_color" data_type= "color" type= "Color" default= "Color(1, 1, 1, 1)" >
2020-02-04 08:46:01 +01:00
Text [Color] used when the [MenuButton] is being pressed.
2017-09-12 22:42:36 +02:00
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "font_size" data_type= "font_size" type= "int" >
2020-08-12 13:49:10 +02:00
Font size of the [MenuButton]'s text.
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "hover" data_type= "style" type= "StyleBox" >
2020-02-04 08:46:01 +01:00
[StyleBox] used when the [MenuButton] is being hovered.
2017-09-12 22:42:36 +02:00
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "hseparation" data_type= "constant" type= "int" default= "3" >
2020-02-04 08:46:01 +01:00
The horizontal space between [MenuButton]'s icon and text.
2017-09-12 22:42:36 +02:00
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "normal" data_type= "style" type= "StyleBox" >
2020-02-04 08:46:01 +01:00
Default [StyleBox] for the [MenuButton].
2017-09-12 22:42:36 +02:00
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "outline_size" data_type= "constant" type= "int" default= "0" >
2020-12-25 22:45:28 +01:00
The size of the text outline.
</theme_item>
2021-08-04 18:54:41 +02:00
<theme_item name= "pressed" data_type= "style" type= "StyleBox" >
2020-02-04 08:46:01 +01:00
[StyleBox] used when the [MenuButton] is being pressed.
2017-09-12 22:42:36 +02:00
</theme_item>
</theme_items>
</class>