MenuButton.xml 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="MenuButton" inherits="Button" version="3.2">
  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 items new properties.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <methods>
  13. <method name="get_popup" qualifiers="const">
  14. <return type="PopupMenu">
  15. </return>
  16. <description>
  17. Returns the [PopupMenu] contained in this button.
  18. </description>
  19. </method>
  20. <method name="set_disable_shortcuts">
  21. <return type="void">
  22. </return>
  23. <argument index="0" name="disabled" type="bool">
  24. </argument>
  25. <description>
  26. If [code]true[/code], shortcuts are disabled and cannot be used to trigger the button.
  27. </description>
  28. </method>
  29. </methods>
  30. <members>
  31. <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" override="true" enum="BaseButton.ActionMode" default="0" />
  32. <member name="enabled_focus_mode" type="int" setter="set_enabled_focus_mode" getter="get_enabled_focus_mode" override="true" enum="Control.FocusMode" 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. </theme_item>
  52. <theme_item name="focus" type="StyleBox">
  53. </theme_item>
  54. <theme_item name="font" type="Font">
  55. </theme_item>
  56. <theme_item name="font_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
  57. </theme_item>
  58. <theme_item name="font_color_disabled" type="Color" default="Color( 1, 1, 1, 0.3 )">
  59. </theme_item>
  60. <theme_item name="font_color_hover" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
  61. </theme_item>
  62. <theme_item name="font_color_pressed" type="Color" default="Color( 1, 1, 1, 1 )">
  63. </theme_item>
  64. <theme_item name="hover" type="StyleBox">
  65. </theme_item>
  66. <theme_item name="hseparation" type="int" default="3">
  67. </theme_item>
  68. <theme_item name="normal" type="StyleBox">
  69. </theme_item>
  70. <theme_item name="pressed" type="StyleBox">
  71. </theme_item>
  72. </theme_items>
  73. </class>