Show / Hide Table of Contents

    Class Window

    A Toplevel View that draws a frame around its region and has a "ContentView" subview where the contents are added.
    Inheritance
    System.Object
    Responder
    View
    Toplevel
    Window
    Dialog
    Implements
    System.Collections.IEnumerable
    Inherited Members
    Toplevel.Running
    Toplevel.Ready
    Toplevel.Create()
    Toplevel.CanFocus
    Toplevel.Modal
    Toplevel.MenuBar
    Toplevel.StatusBar
    Toplevel.ProcessKey(KeyEvent)
    Toplevel.WillPresent()
    View.Enter
    View.Leave
    View.MouseEnter
    View.MouseLeave
    View.Driver
    View.Subviews
    View.Id
    View.IsCurrentTop
    View.WantMousePositionReports
    View.WantContinuousButtonPressed
    View.Frame
    View.LayoutStyle
    View.Bounds
    View.X
    View.Y
    View.Width
    View.Height
    View.SuperView
    View.SetNeedsDisplay()
    View.SetNeedsDisplay(Rect)
    View.ChildNeedsDisplay()
    View.Add(View[])
    View.BringSubviewToFront(View)
    View.SendSubviewToBack(View)
    View.SendSubviewBackwards(View)
    View.BringSubviewForward(View)
    View.Clear()
    View.Clear(Rect)
    View.ScreenToView(Int32, Int32)
    View.ClipToBounds()
    View.SetClip(Rect)
    View.DrawFrame(Rect, Int32, Boolean)
    View.DrawHotString(ustring, Attribute, Attribute)
    View.DrawHotString(ustring, Boolean, ColorScheme)
    View.Move(Int32, Int32)
    View.PositionCursor()
    View.HasFocus
    View.OnEnter()
    View.OnLeave()
    View.Focused
    View.MostFocused
    View.ColorScheme
    View.AddRune(Int32, Int32, Rune)
    View.ClearNeedsDisplay()
    View.SetFocus(View)
    View.KeyPress
    View.ProcessHotKey(KeyEvent)
    View.ProcessColdKey(KeyEvent)
    View.KeyDown
    View.OnKeyDown(KeyEvent)
    View.KeyUp
    View.OnKeyUp(KeyEvent)
    View.EnsureFocus()
    View.FocusFirst()
    View.FocusLast()
    View.FocusPrev()
    View.FocusNext()
    View.LayoutSubviews()
    View.ToString()
    View.OnMouseEnter(MouseEvent)
    View.OnMouseLeave(MouseEvent)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Terminal.Gui
    Assembly: Terminal.Gui.dll
    Syntax
    public class Window : Toplevel, IEnumerable

    Constructors

    Window(ustring)

    Initializes a new instance of the Window class with an optional title.
    Declaration
    public Window(ustring title = null)
    Parameters
    Type Name Description
    NStack.ustring title Title.

    Window(ustring, Int32)

    Initializes a new instance of the Window with the specified frame for its location, with the specified border an optional title.
    Declaration
    public Window(ustring title = null, int padding = 0)
    Parameters
    Type Name Description
    NStack.ustring title Title.
    System.Int32 padding Number of characters to use for padding of the drawn frame.

    Window(Rect, ustring)

    Initializes a new instance of the Window class with an optional title and a set frame.
    Declaration
    public Window(Rect frame, ustring title = null)
    Parameters
    Type Name Description
    Rect frame Frame.
    NStack.ustring title Title.

    Window(Rect, ustring, Int32)

    Initializes a new instance of the Window with the specified frame for its location, with the specified border an optional title.
    Declaration
    public Window(Rect frame, ustring title = null, int padding = 0)
    Parameters
    Type Name Description
    Rect frame Frame.
    NStack.ustring title Title.
    System.Int32 padding Number of characters to use for padding of the drawn frame.

    Properties

    Title

    The title to be displayed for this window.
    Declaration
    public ustring Title { get; set; }
    Property Value
    Type Description
    NStack.ustring The title.

    Methods

    Add(View)

    Add the specified view to the Terminal.Gui.Window.ContentView.
    Declaration
    public override void Add(View view)
    Parameters
    Type Name Description
    View view View to add to the window.
    Overrides
    Toplevel.Add(View)

    GetEnumerator()

    Enumerates the various Views in the embedded Terminal.Gui.Window.ContentView.
    Declaration
    public IEnumerator GetEnumerator()
    Returns
    Type Description
    System.Collections.IEnumerator The enumerator.

    MouseEvent(MouseEvent)

    Declaration
    public override bool MouseEvent(MouseEvent mouseEvent)
    Parameters
    Type Name Description
    MouseEvent mouseEvent
    Returns
    Type Description
    System.Boolean
    Overrides
    Responder.MouseEvent(MouseEvent)

    Redraw(Rect)

    Declaration
    public override void Redraw(Rect bounds)
    Parameters
    Type Name Description
    Rect bounds
    Overrides
    Toplevel.Redraw(Rect)

    Remove(View)

    Removes a widget from this container.
    Declaration
    public override void Remove(View view)
    Parameters
    Type Name Description
    View view
    Overrides
    Toplevel.Remove(View)
    Remarks

    RemoveAll()

    Removes all widgets from this container.
    Declaration
    public override void RemoveAll()
    Overrides
    Toplevel.RemoveAll()
    Remarks

    Implements

    System.Collections.IEnumerable
    Back to top Generated by DocFX