MenuButton.xml 3.8 KB

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