Documentation
¶
Overview ¶
A button that brings up a PopupMenu when clicked. To create new items inside this PopupMenu, use get_popup().add_item("My Item Name"). You can also create them directly from Godot editor's inspector.
See also BaseButton which contains common properties and methods associated with this node.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsBaseButton() BaseButton.Instance
- func (self *Extension[T]) AsButton() Button.Instance
- func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
- func (self *Extension[T]) AsControl() Control.Instance
- func (self *Extension[T]) AsMenuButton() Instance
- func (self *Extension[T]) AsNode() Node.Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- type ID
- type Instance
- func (self Instance) AsBaseButton() BaseButton.Instance
- func (self Instance) AsButton() Button.Instance
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsControl() Control.Instance
- func (self Instance) AsMenuButton() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) GetPopup() PopupMenu.Instance
- func (self Instance) ID() ID
- func (self Instance) ItemCount() int
- func (self Instance) OnAboutToPopup(cb func(), flags ...Signal.Flags)
- func (self Instance) SetDisableShortcuts(disabled bool)
- func (self Instance) SetItemCount(value int)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetSwitchOnHover(value bool)
- func (self Instance) ShowPopup()
- func (self Instance) SwitchOnHover() bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsBaseButton ¶
func (self *Extension[T]) AsBaseButton() BaseButton.Instance
func (*Extension[T]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
func (*Extension[T]) AsMenuButton ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.MenuButton
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsBaseButton ¶
func (self Instance) AsBaseButton() BaseButton.Instance
func (Instance) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) AsMenuButton ¶
func (Instance) GetPopup ¶
Returns the PopupMenu contained in this button.
Warning: 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 Window.Visible property.
func (Instance) OnAboutToPopup ¶
func (Instance) SetDisableShortcuts ¶
If true, shortcuts are disabled and cannot be used to trigger the button.
func (Instance) SetItemCount ¶
func (Instance) SetSwitchOnHover ¶
func (Instance) ShowPopup ¶
func (self Instance) ShowPopup()
Adjusts popup position and sizing for the MenuButton, then shows the PopupMenu. Prefer this over using get_popup().popup().
Source Files