using NStack; using System; using System.Collections.Generic; using System.ComponentModel; using System.Xml.Linq; using Terminal.Gui.Graphs; namespace Terminal.Gui { /// /// Frames are a special form of that act as adornments; they appear outside of the /// enabling borders, menus, etc... /// public class Frame : View { // TODO: v2 - If a Frame has focus, navigation keys (e.g Command.NextView) should cycle through SubViews of the Frame // QUESTION: How does a user navigate out of a Frame to another Frame, or back into the Parent's SubViews? /// /// Frames are a special form of that act as adornments; they appear outside of the /// enabling borders, menus, etc... /// public Frame () { } /// /// The Parent of this Frame. /// public View Parent { get; set; } /// /// Frames cannot be used as sub-views, so this method always throws an . /// TODO: Are we sure? /// public override View SuperView { get { return null; } set { throw new NotImplementedException (); } } /// public override void ViewToScreen (int col, int row, out int rcol, out int rrow, bool clipped = true) { // Frames are *Children* of a View, not SubViews. Thus View.ViewToScreen will not work. // To get the screen-relative coordinates of a Frame, we need to know who // the Parent is var parentFrame = Parent?.Frame ?? Frame; rrow = row + parentFrame.Y; rcol = col + parentFrame.X; // We now have rcol/rrow in coordinates relative to our SuperView. If our SuperView has // a SuperView, keep going... Parent?.SuperView?.SuperView?.ViewToScreen (rcol, rrow, out rcol, out rrow, clipped); } /// /// /// /// public virtual void OnDrawSubViews (Rect clipRect) { // if (Subviews == null) { // return; // } // foreach (var view in Subviews) { // // BUGBUG: v2 - shouldn't this be !view.LayoutNeeded? Why draw if layout is going to happen and we'll just draw again? // if (view.LayoutNeeded) { // view.LayoutSubviews (); // } // if ((view.Visible && !view.NeedDisplay.IsEmpty && view.Frame.Width > 0 && view.Frame.Height > 0) || view.ChildNeedsDisplay) { // view.Redraw (view.Bounds); // view.NeedDisplay = Rect.Empty; // // BUGBUG - v2 why does this need to be set to false? // // Shouldn't it be set when the subviews draw? // view.ChildNeedsDisplay = false; // } // } } /// public override void OnDrawContent (Rect viewport) { if (!ustring.IsNullOrEmpty (TextFormatter.Text)) { Clear (viewport); SetSubViewNeedsDisplay (); // Draw any Text if (TextFormatter != null) { TextFormatter.NeedsFormat = true; Rect containerBounds = GetContainerBounds (); TextFormatter?.Draw (ViewToScreen (viewport), HasFocus ? ColorScheme.Focus : GetNormalColor (), HasFocus ? ColorScheme.HotFocus : Enabled ? ColorScheme.HotNormal : ColorScheme.Disabled, containerBounds); } } } /// /// Redraws the Frames that comprise the . /// /// public override void Redraw (Rect clipRect) { //OnDrawContent (bounds); //OnDrawSubViews (bounds); //OnDrawContentComplete (bounds); if (ColorScheme != null) { Driver.SetAttribute (ColorScheme.Normal); } var screenBounds = ViewToScreen (Frame); Thickness.Draw (screenBounds, (string)Data); //OnDrawContent (bounds); if (BorderStyle != BorderStyle.None) { var lc = new LineCanvas (); lc.AddLine (screenBounds.Location, Frame.Width - 1, Orientation.Horizontal, BorderStyle); lc.AddLine (screenBounds.Location, Frame.Height - 1, Orientation.Vertical, BorderStyle); lc.AddLine (new Point (screenBounds.X, screenBounds.Y + screenBounds.Height - 1), screenBounds.Width - 1, Orientation.Horizontal, BorderStyle); lc.AddLine (new Point (screenBounds.X + screenBounds.Width - 1, screenBounds.Y), screenBounds.Height - 1, Orientation.Vertical, BorderStyle); foreach (var p in lc.GenerateImage (screenBounds)) { Driver.Move (p.Key.X, p.Key.Y); Driver.AddRune (p.Value); } if (!ustring.IsNullOrEmpty (Parent?.Title)) { Driver.DrawWindowTitle (screenBounds, Parent?.Title, 0, 0, 0, 0); } } } //public Label DiagnosticsLabel { get; set; } // TODO: v2 = This is teporary; need to also enable (or not) simple way of setting // other border properties // TOOD: v2 - Missing 3D effect /// /// /// public BorderStyle BorderStyle { get; set; } = BorderStyle.None; /// /// Defines the rectangle that the will use to draw its content. /// public Thickness Thickness { get; set; } // TODO: v2 - This is confusing. It is a read-only property and actually only returns a size, so // should not be a Rect. However, it may make sense to keep it a Rect and support negative Location // for scrolling. Still noodling this. /// /// Gets the rectangle that describes the inner area of the frame. The Location is always 0, 0. /// public override Rect Bounds { get { if (Thickness == null) { return new Rect (Point.Empty, Frame.Size); } // Return the frame-relative bounds return Thickness.GetInnerRect (new Rect (Point.Empty, Frame.Size)); } set { throw new InvalidOperationException ("It makes no sense to explicitly set Bounds."); } } } }