MenuButton.xml 5.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="MenuButton" inherits="Button" version="4.0">
  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 Window.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="items_count" type="int" setter="set_item_count" getter="get_item_count" default="0">
  34. The number of items currently in the list.
  35. </member>
  36. <member name="switch_on_hover" type="bool" setter="set_switch_on_hover" getter="is_switch_on_hover" default="false">
  37. 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.
  38. </member>
  39. <member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" override="true" default="true" />
  40. </members>
  41. <signals>
  42. <signal name="about_to_popup">
  43. <description>
  44. Emitted when the [PopupMenu] of this MenuButton is about to show.
  45. </description>
  46. </signal>
  47. </signals>
  48. <theme_items>
  49. <theme_item name="disabled" data_type="style" type="StyleBox">
  50. [StyleBox] used when the [MenuButton] is disabled.
  51. </theme_item>
  52. <theme_item name="focus" data_type="style" type="StyleBox">
  53. [StyleBox] used when the [MenuButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
  54. </theme_item>
  55. <theme_item name="font" data_type="font" type="Font">
  56. [Font] of the [MenuButton]'s text.
  57. </theme_item>
  58. <theme_item name="font_color" data_type="color" type="Color" default="Color(0.88, 0.88, 0.88, 1)">
  59. Default text [Color] of the [MenuButton].
  60. </theme_item>
  61. <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(1, 1, 1, 0.3)">
  62. Text [Color] used when the [MenuButton] is disabled.
  63. </theme_item>
  64. <theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)">
  65. 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.
  66. </theme_item>
  67. <theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)">
  68. Text [Color] used when the [MenuButton] is being hovered.
  69. </theme_item>
  70. <theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
  71. The tint of text outline of the [MenuButton].
  72. </theme_item>
  73. <theme_item name="font_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
  74. Text [Color] used when the [MenuButton] is being pressed.
  75. </theme_item>
  76. <theme_item name="font_size" data_type="font_size" type="int">
  77. Font size of the [MenuButton]'s text.
  78. </theme_item>
  79. <theme_item name="hover" data_type="style" type="StyleBox">
  80. [StyleBox] used when the [MenuButton] is being hovered.
  81. </theme_item>
  82. <theme_item name="hseparation" data_type="constant" type="int" default="3">
  83. The horizontal space between [MenuButton]'s icon and text.
  84. </theme_item>
  85. <theme_item name="normal" data_type="style" type="StyleBox">
  86. Default [StyleBox] for the [MenuButton].
  87. </theme_item>
  88. <theme_item name="outline_size" data_type="constant" type="int" default="0">
  89. The size of the text outline.
  90. </theme_item>
  91. <theme_item name="pressed" data_type="style" type="StyleBox">
  92. [StyleBox] used when the [MenuButton] is being pressed.
  93. </theme_item>
  94. </theme_items>
  95. </class>