Documentation
¶
Overview ¶
graphics.gd/classdb/BaseButton is an abstract base class for GUI buttons. It doesn't display anything by itself.
Index ¶
- type ActionMode
- type Advanced
- type Any
- type DrawMode
- type Extension
- type ID
- type Implementation
- type Instance
- func (self Instance) ActionMode() ActionMode
- func (self Instance) AsBaseButton() Instance
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsControl() Control.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) ButtonMask() Input.MouseButtonMask
- func (self Instance) ButtonPressed() bool
- func (self Instance) Disabled() bool
- func (self Instance) GetDrawMode() DrawMode
- func (self Instance) ID() ID
- func (self Instance) IsHovered() bool
- func (self Instance) KeepPressedOutside() bool
- func (self Instance) OnButtonDown(cb func(), flags ...Signal.Flags)
- func (self Instance) OnButtonUp(cb func(), flags ...Signal.Flags)
- func (self Instance) OnPressed(cb func(), flags ...Signal.Flags)
- func (self Instance) OnToggled(cb func(toggled_on bool), flags ...Signal.Flags)
- func (self Instance) SetActionMode(value ActionMode)
- func (self Instance) SetButtonMask(value Input.MouseButtonMask)
- func (self Instance) SetButtonPressed(value bool)
- func (self Instance) SetDisabled(value bool)
- func (self Instance) SetKeepPressedOutside(value bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPressedNoSignal(pressed bool)
- func (self Instance) SetShortcut(value Shortcut.Instance)
- func (self Instance) SetShortcutFeedback(value bool)
- func (self Instance) SetShortcutInTooltip(value bool)
- func (self Instance) SetToggleMode(value bool)
- func (self Instance) Shortcut() Shortcut.Instance
- func (self Instance) ShortcutFeedback() bool
- func (self Instance) ShortcutInTooltip() bool
- func (self Instance) ToggleMode() bool
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActionMode ¶
type ActionMode int //gd:BaseButton.ActionMode
const ( // Require just a press to consider the button clicked. ActionModeButtonPress ActionMode = 0 // Require a press and a subsequent release before considering the button clicked. ActionModeButtonRelease ActionMode = 1 )
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 DrawMode ¶
type DrawMode int //gd:BaseButton.DrawMode
const ( // The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons. DrawNormal DrawMode = 0 // The state of buttons are pressed. DrawPressed DrawMode = 1 // The state of buttons are hovered. DrawHover DrawMode = 2 // The state of buttons are disabled. DrawDisabled DrawMode = 3 // The state of buttons are both hovered and pressed. DrawHoverPressed DrawMode = 4 )
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]See Interface for methods that can be overridden by T.
func (*Extension[T]) AsBaseButton ¶
func (*Extension[T]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
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 Implementation ¶
type Implementation = implementation
Implementation implements Interface with empty methods.
type Instance ¶
type Instance [1]gdclass.BaseButton
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) ActionMode ¶
func (self Instance) ActionMode() ActionMode
func (Instance) AsBaseButton ¶
func (Instance) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) ButtonMask ¶
func (self Instance) ButtonMask() Input.MouseButtonMask
func (Instance) ButtonPressed ¶
func (Instance) GetDrawMode ¶
Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DrawMode enum.
func (Instance) IsHovered ¶
Returns true if the mouse has entered the button and has not left it yet.
func (Instance) KeepPressedOutside ¶
func (Instance) OnButtonDown ¶
func (Instance) OnButtonUp ¶
func (Instance) SetActionMode ¶
func (self Instance) SetActionMode(value ActionMode)
func (Instance) SetButtonMask ¶
func (self Instance) SetButtonMask(value Input.MouseButtonMask)
func (Instance) SetButtonPressed ¶
func (Instance) SetDisabled ¶
func (Instance) SetKeepPressedOutside ¶
func (Instance) SetPressedNoSignal ¶
Changes the Instance.ButtonPressed state of the button, without emitting Instance.OnToggled. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if Instance.ToggleMode is true.
Note: This method doesn't unpress other buttons in [Instance.ButtonGroup].
func (Instance) SetShortcut ¶
func (Instance) SetShortcutFeedback ¶
func (Instance) SetShortcutInTooltip ¶
func (Instance) SetToggleMode ¶
func (Instance) ShortcutFeedback ¶
func (Instance) ShortcutInTooltip ¶
func (Instance) ToggleMode ¶
type Interface ¶
type Interface interface {
// Called when the button is pressed. If you need to know the button's pressed state (and [Instance.ToggleMode] is active), use [Interface.Toggled] instead.
Pressed()
// Called when the button is toggled (only if [Instance.ToggleMode] is active).
Toggled(toggled_on bool)
}
Source Files