BaseButton

public BaseButton();

Creates a base button: ToggleMode = false, Disabled = false, ActionMode = Release, ButtonMask = Left, FocusMode = All. Use a derived Button for standard visuals.

public BaseButton.ActionModeEnum ActionMode { get; set; }

Input activation timing: Press on press, Release on release, default Release. Programmatic Press and Shortcut activation are immediate.

public ButtonGroup ButtonGroup { get; set; }

Shared toggle-button group resource, or null. Assignment registers membership without selecting a button or repairing existing conflicts. Do not use with ToggleMode = false.

public MouseButtonMask ButtonMask { get; set; }

Accepted mouse-button bitmask, default Left. Combine MouseButtonMask.Left | MouseButtonMask.Right if needed. Does not disable ui_accept or Shortcut.

public bool ButtonPressed { get; set; }

Toggle-button state. Setter only works in ToggleMode and emits Toggled on ordinary changes rather than Pressed. For ordinary buttons, IsPressed reflects a press attempt rather than a persistent setting.

public bool Disabled { get; set; }

Blocks Press activation, default false. Does not forbid programmatic SetPressed; own Toggled/callback are suppressed while disabled. An already selected toggle is not necessarily cleared.

public bool KeepPressedOutside { get; set; }

Retains pressed appearance when the pointer leaves during holding, default false. Does not allow activation on outside release.

public Shortcut Shortcut { get; set; }

Shared Shortcut resource, or null. Assignment enables shortcut processing; a matching non-echo event invokes Press on a visible button. Disabled blocks activation.

public bool ShortcutFeedback { get; set; }

Show brief visual feedback for Shortcut activation, default true. false does not disable the shortcut itself.

public bool ShortcutInTooltip { get; set; }

Include Shortcut information in the standard tooltip, default true. Does not enable/disable shortcut handling; custom tooltips can be supplied separately.

public bool ToggleMode { get; set; }

Retain on/off state, default false. CheckBox/CheckButton enable this in their constructors. Disabling the mode first clears toggle state through the ordinary setter and can emit Toggled.

public BaseButton.ActionModeEnum GetActionMode();

Input activation timing: Press on press, Release on release, default Release. Programmatic Press and Shortcut activation are immediate.

public ButtonGroup GetButtonGroup();

Shared toggle-button group resource, or null. Assignment registers membership without selecting a button or repairing existing conflicts. Do not use with ToggleMode = false.

public MouseButtonMask GetButtonMask();

Accepted mouse-button bitmask, default Left. Combine MouseButtonMask.Left | MouseButtonMask.Right if needed. Does not disable ui_accept or Shortcut.

public BaseButton.DrawMode GetDrawMode();

Returns logical Normal/Pressed/Hover/Disabled/HoverPressed drawing mode, accounting for interaction and shortcut feedback. Neither a theme setter nor stored ButtonPressed.

public Shortcut GetShortcut();

Shared Shortcut resource, or null. Assignment enables shortcut processing; a matching non-echo event invokes Press on a visible button. Disabled blocks activation.

public bool IsDisabled();

Blocks Press activation, default false. Does not forbid programmatic SetPressed; own Toggled/callback are suppressed while disabled. An already selected toggle is not necessarily cleared.

public bool IsHovered();

Returns hover state tracked by UI events. Not a test of an arbitrary global coordinate or keyboard focus.

public bool IsKeepPressedOutside();

Retains pressed appearance when the pointer leaves during holding, default false. Does not allow activation on outside release.

public bool IsPressed();

Toggle-button state. Setter only works in ToggleMode and emits Toggled on ordinary changes rather than Pressed. For ordinary buttons, IsPressed reflects a press attempt rather than a persistent setting.

public bool IsShortcutFeedback();

Show brief visual feedback for Shortcut activation, default true. false does not disable the shortcut itself.

public bool IsShortcutInTooltipEnabled();

Include Shortcut information in the standard tooltip, default true. Does not enable/disable shortcut handling; custom tooltips can be supplied separately.

public bool IsToggleMode();

Retain on/off state, default false. CheckBox/CheckButton enable this in their constructors. Disabling the mode first clears toggle state through the ordinary setter and can emit Toggled.

public void Press();

Immediately activates, respecting Disabled. In toggle mode changes state and reconciles the group, then invokes Toggled and Pressed. Does not create ButtonDown/ButtonUp or require physical input. Re-activating a mandatory group selection can retain true while notifying again.

public void SetActionMode(BaseButton.ActionModeEnum mode);

Input activation timing: Press on press, Release on release, default Release. Programmatic Press and Shortcut activation are immediate.

public void SetButtonGroup(ButtonGroup buttonGroup);

Shared toggle-button group resource, or null. Assignment registers membership without selecting a button or repairing existing conflicts. Do not use with ToggleMode = false.

public void SetButtonMask(MouseButtonMask mask);

Accepted mouse-button bitmask, default Left. Combine MouseButtonMask.Left | MouseButtonMask.Right if needed. Does not disable ui_accept or Shortcut.

public void SetDisabled(bool disabled);

Blocks Press activation, default false. Does not forbid programmatic SetPressed; own Toggled/callback are suppressed while disabled. An already selected toggle is not necessarily cleared.

public void SetKeepPressedOutside(bool enabled);

Retains pressed appearance when the pointer leaves during holding, default false. Does not allow activation on outside release.

public void SetPressed(bool pressed);

Toggle-button state. Setter only works in ToggleMode and emits Toggled on ordinary changes rather than Pressed. For ordinary buttons, IsPressed reflects a press attempt rather than a persistent setting.

public void SetPressedNoSignal(bool pressed);

Changes state only in ToggleMode without Toggled/_Toggled, Pressed or group signals. Does not clear ButtonGroup peers and can create multiple selections. Explicitly refresh dependent application state.

public void SetShortcut(Shortcut shortcut);

Shared Shortcut resource, or null. Assignment enables shortcut processing; a matching non-echo event invokes Press on a visible button. Disabled blocks activation.

public void SetShortcutFeedback(bool enabled);

Show brief visual feedback for Shortcut activation, default true. false does not disable the shortcut itself.

public void SetShortcutInTooltip(bool enabled);

Include Shortcut information in the standard tooltip, default true. Does not enable/disable shortcut handling; custom tooltips can be supplied separately.

public void SetToggleMode(bool enabled);

Retain on/off state, default false. CheckBox/CheckButton enable this in their constructors. Disabling the mode first clears toggle state through the ordinary setter and can emit Toggled.

public virtual void _Pressed();

Subclass virtual activation callback before Pressed. Not invoked by ordinary toggle-state assignment. Do not call it instead of Press to simulate activation.

public virtual void _Toggled(bool toggledOn);

Virtual callback before Toggled on toggle-state notification. SetPressedNoSignal and Disabled suppress it; notification count need not equal the number of state transitions.

public event Action ButtonDown;

Beginning of accepted holding through input. Not final activation or programmatic Press. Pressed timing separately depends on ActionMode.

public event Action ButtonUp;

End of accepted input holding; disabling an active button can also end it. Does not guarantee activation and is not generated by programmatic Press.

public event Action Pressed;

Button activated through user input or Press. Ordinary SetPressed/SetPressedNoSignal do not emit it. Use Toggled and ButtonPressed for toggle state.

public event BaseButton.ToggledEventHandler Toggled;

Toggle-state notification. An ordinary changed SetPressed emits it; SetPressedNoSignal and Disabled suppress it. Press on a mandatory group’s selected button can report true again without a state change.