// // Button.cs: Button control // // Authors: // Miguel de Icaza (miguel@gnome.org) // using System; using NStack; namespace Terminal.Gui { /// /// Button is a that provides an item that invokes an when activated by the user. /// /// /// /// Provides a button showing text invokes an when clicked on with a mouse /// or when the user presses SPACE, ENTER, or hotkey. The hotkey is specified by the first uppercase /// letter in the button. /// /// /// When the button is configured as the default () and the user presses /// the ENTER key, if no other processes the , the 's /// will be invoked. /// /// public class Button : View { ustring text; ustring shown_text; Rune hot_key; int hot_pos = -1; bool is_default; /// /// Gets or sets whether the is the default action to activate in a dialog. /// /// true if is default; otherwise, false. public bool IsDefault { get => is_default; set { is_default = value; SetWidthHeight (Text, is_default); Update (); } } /// /// Clicked , raised when the button is clicked. /// /// /// Client code can hook up to this event, it is /// raised when the button is activated either with /// the mouse or the keyboard. /// public Action Clicked; /// /// 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 () : this (string.Empty) { } /// /// Initializes a new instance of using layout. /// /// /// The width of the is computed based on the /// text length. The height will always be 1. /// /// The button's text /// /// If true, a special decoration is used, and the user pressing the enter key /// in a will implicitly activate this button. /// public Button (ustring text, bool is_default = false) : base () { CanFocus = true; Text = text ?? string.Empty; this.IsDefault = is_default; int w = SetWidthHeight (text, is_default); Frame = new Rect (Frame.Location, new Size (w, 1)); } /// /// Initializes a new instance of using layout, based on the given text /// /// /// The width of the is computed based on the /// text length. The height will always be 1. /// /// X position where the button will be shown. /// Y position where the button will be shown. /// The button's text public Button (int x, int y, ustring text) : this (x, y, text, false) { } /// /// Initializes a new instance of using layout, based on the given text. /// /// /// The width of the is computed based on the /// text length. The height will always be 1. /// /// X position where the button will be shown. /// Y position where the button will be shown. /// The button's text /// /// If true, a special decoration is used, and the user pressing the enter key /// in a will implicitly activate this button. /// public Button (int x, int y, ustring text, bool is_default) : base (new Rect (x, y, text.Length + 4 + (is_default ? 2 : 0), 1)) { CanFocus = true; Text = text ?? string.Empty; this.IsDefault = is_default; } int SetWidthHeight (ustring text, bool is_default) { int w = text.Length + 4 + (is_default ? 2 : 0); Width = w; Height = 1; Frame = new Rect (Frame.Location, new Size (w, 1)); return w; } /// /// The text displayed by this . /// public ustring Text { get { return text; } set { if (text?.Length != value?.Length) { SetWidthHeight (value, is_default); } text = value; Update (); } } internal void Update () { if (IsDefault) shown_text = "[< " + text + " >]"; else shown_text = "[ " + text + " ]"; hot_key = (Rune)0; hot_pos = shown_text.IndexOf ('_'); if (hot_pos == -1) { // Use first upper-case char int i = 0; foreach (Rune c in shown_text) { if (Rune.IsUpper (c)) { hot_key = c; hot_pos = i; break; } i++; } } else { // Use char after '_' var start = shown_text [0, hot_pos]; shown_text = start + shown_text [hot_pos + 1, shown_text.Length]; hot_key = Char.ToUpper((char)shown_text [hot_pos]); } SetNeedsDisplay (); } /// public override void Redraw (Rect bounds) { Driver.SetAttribute (HasFocus ? ColorScheme.Focus : ColorScheme.Normal); Move (0, 0); Driver.AddStr (shown_text); if (hot_pos != -1) { Move (hot_pos, 0); Driver.SetAttribute (HasFocus ? ColorScheme.HotFocus : ColorScheme.HotNormal); Driver.AddRune (hot_key); } } /// public override void PositionCursor () { Move (hot_pos == -1 ? 1 : hot_pos, 0); } bool CheckKey (KeyEvent key) { if (Char.ToUpper ((char)key.KeyValue) == hot_key) { this.SuperView.SetFocus (this); Clicked?.Invoke (); return true; } return false; } /// public override bool ProcessHotKey (KeyEvent kb) { if (kb.IsAlt) return CheckKey (kb); return false; } /// public override bool ProcessColdKey (KeyEvent kb) { if (IsDefault && kb.KeyValue == '\n') { if (Clicked != null) Clicked (); return true; } return CheckKey (kb); } /// public override bool ProcessKey (KeyEvent kb) { var c = kb.KeyValue; if (c == '\n' || c == ' ' || Rune.ToUpper ((uint)c) == hot_key) { if (Clicked != null) Clicked (); return true; } return base.ProcessKey (kb); } /// public override bool MouseEvent (MouseEvent me) { if (me.Flags == MouseFlags.Button1Clicked) { SuperView.SetFocus (this); SetNeedsDisplay (); if (Clicked != null) Clicked (); return true; } return false; } } }