MenuButton.xml 4.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="MenuButton" inherits="Button" version="3.4">
  3. <brief_description>
  4. Special button that brings up a [PopupMenu] when clicked.
  5. </brief_description>
  6. <description>
  7. Special button that brings up a [PopupMenu] when clicked.
  8. 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.
  9. See also [BaseButton] which contains common properties and methods associated with this node.
  10. </description>
  11. <tutorials>
  12. </tutorials>
  13. <methods>
  14. <method name="get_popup" qualifiers="const">
  15. <return type="PopupMenu" />
  16. <description>
  17. Returns the [PopupMenu] contained in this button.
  18. [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 CanvasItem.visible] property.
  19. </description>
  20. </method>
  21. <method name="set_disable_shortcuts">
  22. <return type="void" />
  23. <argument index="0" name="disabled" type="bool" />
  24. <description>
  25. If [code]true[/code], shortcuts are disabled and cannot be used to trigger the button.
  26. </description>
  27. </method>
  28. </methods>
  29. <members>
  30. <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" override="true" enum="BaseButton.ActionMode" default="0" />
  31. <member name="flat" type="bool" setter="set_flat" getter="is_flat" override="true" default="true" />
  32. <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="0" />
  33. <member name="switch_on_hover" type="bool" setter="set_switch_on_hover" getter="is_switch_on_hover" default="false">
  34. 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.
  35. </member>
  36. <member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" override="true" default="true" />
  37. </members>
  38. <signals>
  39. <signal name="about_to_show">
  40. <description>
  41. Emitted when [PopupMenu] of this MenuButton is about to show.
  42. </description>
  43. </signal>
  44. </signals>
  45. <constants>
  46. </constants>
  47. <theme_items>
  48. <theme_item name="disabled" data_type="style" type="StyleBox">
  49. [StyleBox] used when the [MenuButton] is disabled.
  50. </theme_item>
  51. <theme_item name="focus" data_type="style" type="StyleBox">
  52. [StyleBox] used when the [MenuButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
  53. </theme_item>
  54. <theme_item name="font" data_type="font" type="Font">
  55. [Font] of the [MenuButton]'s text.
  56. </theme_item>
  57. <theme_item name="font_color" data_type="color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
  58. Default text [Color] of the [MenuButton].
  59. </theme_item>
  60. <theme_item name="font_color_disabled" data_type="color" type="Color" default="Color( 1, 1, 1, 0.3 )">
  61. Text [Color] used when the [MenuButton] is disabled.
  62. </theme_item>
  63. <theme_item name="font_color_focus" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
  64. 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.
  65. </theme_item>
  66. <theme_item name="font_color_hover" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
  67. Text [Color] used when the [MenuButton] is being hovered.
  68. </theme_item>
  69. <theme_item name="font_color_pressed" data_type="color" type="Color" default="Color( 1, 1, 1, 1 )">
  70. Text [Color] used when the [MenuButton] is being pressed.
  71. </theme_item>
  72. <theme_item name="hover" data_type="style" type="StyleBox">
  73. [StyleBox] used when the [MenuButton] is being hovered.
  74. </theme_item>
  75. <theme_item name="hseparation" data_type="constant" type="int" default="3">
  76. The horizontal space between [MenuButton]'s icon and text.
  77. </theme_item>
  78. <theme_item name="normal" data_type="style" type="StyleBox">
  79. Default [StyleBox] for the [MenuButton].
  80. </theme_item>
  81. <theme_item name="pressed" data_type="style" type="StyleBox">
  82. [StyleBox] used when the [MenuButton] is being pressed.
  83. </theme_item>
  84. </theme_items>
  85. </class>