//
// Button.cs: Button control
//
// Authors:
// Miguel de Icaza (miguel@gnome.org)
//
namespace Terminal.Gui;
/// Button is a that provides an item that invokes raises the event.
///
///
/// Provides a button showing text that raises the event when clicked on with a mouse or
/// when the user presses SPACE, ENTER, or the . The hot key is the first letter or digit
/// following the first underscore ('_') in the button text.
///
/// Use to change the hot key specifier from the default of ('_').
///
/// When the button is configured as the default () and the user presses the ENTER key, if
/// no other processes the key, the 's event will
/// be fired.
///
///
/// Set to to have the event
/// invoked repeatedly while the button is pressed.
///
///
public class Button : View
{
private readonly Rune _leftBracket;
private readonly Rune _leftDefault;
private readonly Rune _rightBracket;
private readonly Rune _rightDefault;
private bool _isDefault;
/// Initializes a new instance of using layout.
/// The width of the is computed based on the text length. The height will always be 1.
public Button ()
{
TextAlignment = TextAlignment.Centered;
VerticalTextAlignment = VerticalTextAlignment.Middle;
_leftBracket = Glyphs.LeftBracket;
_rightBracket = Glyphs.RightBracket;
_leftDefault = Glyphs.LeftDefaultIndicator;
_rightDefault = Glyphs.RightDefaultIndicator;
// Ensures a height of 1 if AutoSize is set to false
Height = 1;
CanFocus = true;
AutoSize = true;
HighlightOnPress = true;
// Override default behavior of View
AddCommand (Command.HotKey, () =>
{
SetFocus ();
return !OnAccept ();
});
KeyBindings.Add (Key.Space, Command.HotKey);
KeyBindings.Add (Key.Enter, Command.HotKey);
TitleChanged += Button_TitleChanged;
MouseEvent += Button_MouseEvent;
//MouseClick += Button_MouseClick;
}
[CanBeNull]
private ColorScheme _savedColorScheme;
private void Button_MouseEvent (object sender, MouseEventEventArgs e)
{
if (e.MouseEvent.Flags.HasFlag(MouseFlags.Button1Clicked))
{
if (Application.MouseGrabView != this)
{
e.Handled = InvokeCommand (Command.HotKey) == true;
return;
}
}
if (e.MouseEvent.Flags == MouseFlags.Button1Pressed)
{
if (Application.MouseGrabView == this)
{
e.Handled = InvokeCommand (Command.HotKey) == true;
return;
}
SetFocus();
Application.GrabMouse(this);
_savedColorScheme = ColorScheme;
var cs = new ColorScheme (new Attribute (ColorScheme.Normal.Background, ColorScheme.Normal.Foreground));
ColorScheme = cs;
}
if (e.MouseEvent.Flags.HasFlag(MouseFlags.Button1Released))
{
Application.UngrabMouse ();
e.Handled = InvokeCommand (Command.HotKey) == true;
if (_savedColorScheme is { })
{
ColorScheme = _savedColorScheme;
}
_savedColorScheme = null;
}
}
///
public override bool OnLeave (View view)
{
//Application.UngrabMouse();
return base.OnLeave (view);
}
private void Button_MouseClick (object sender, MouseEventEventArgs e)
{
e.Handled = InvokeCommand (Command.HotKey) == true;
}
private void Button_TitleChanged (object sender, StateEventArgs e)
{
base.Text = e.NewValue;
TextFormatter.HotKeySpecifier = HotKeySpecifier;
}
///
public override string Text
{
get => base.Title;
set => base.Text = base.Title = value;
}
///
public override Rune HotKeySpecifier
{
get => base.HotKeySpecifier;
set => TextFormatter.HotKeySpecifier = base.HotKeySpecifier = value;
}
/// Gets or sets whether the is the default action to activate in a dialog.
/// true if is default; otherwise, false.
public bool IsDefault
{
get => _isDefault;
set
{
_isDefault = value;
UpdateTextFormatterText ();
OnResizeNeeded ();
}
}
///
public bool NoDecorations { get; set; }
///
public bool NoPadding { get; set; }
///
public override bool OnEnter (View view)
{
Application.Driver.SetCursorVisibility (CursorVisibility.Invisible);
return base.OnEnter (view);
}
///
public override void PositionCursor ()
{
if (HotKey.IsValid && Text != "")
{
for (var i = 0; i < TextFormatter.Text.GetRuneCount (); i++)
{
if (TextFormatter.Text [i] == Text [0])
{
Move (i, 0);
return;
}
}
}
base.PositionCursor ();
}
///
protected override void UpdateTextFormatterText ()
{
if (NoDecorations)
{
TextFormatter.Text = Text;
}
else if (IsDefault)
{
TextFormatter.Text = $"{_leftBracket}{_leftDefault} {Text} {_rightDefault}{_rightBracket}";
}
else
{
if (NoPadding)
{
TextFormatter.Text = $"{_leftBracket}{Text}{_rightBracket}";
}
else
{
TextFormatter.Text = $"{_leftBracket} {Text} {_rightBracket}";
}
}
}
}