Class Window

Namespace: Terminal.Gui

Assembly: Terminal.Gui.dll

A Toplevel View that draws a border around its Frame with a Title at the top.

public class Window : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize

Inheritance: object

Responder

View

Toplevel

Window

Implements: IDisposable

ISupportInitializeNotification

ISupportInitialize

Derived: Dialog

Inherited Members: Toplevel.Running

Toplevel.Loaded

Toplevel.Ready

Toplevel.Unloaded

Toplevel.Activate

Toplevel.Deactivate

Toplevel.ChildClosed

Toplevel.AllChildClosed

Toplevel.Closing

Toplevel.Closed

Toplevel.ChildLoaded

Toplevel.ChildUnloaded

Toplevel.Resized

Toplevel.OnLoaded()

Toplevel.AlternateForwardKeyChanged

Toplevel.OnAlternateForwardKeyChanged(Key)

Toplevel.AlternateBackwardKeyChanged

Toplevel.OnAlternateBackwardKeyChanged(Key)

Toplevel.QuitKeyChanged

Toplevel.OnQuitKeyChanged(Key)

Toplevel.Create()

Toplevel.CanFocus

Toplevel.Modal

Toplevel.MenuBar

Toplevel.StatusBar

Toplevel.IsMdiContainer

Toplevel.IsMdiChild

Toplevel.OnKeyDown(KeyEvent)

Toplevel.OnKeyUp(KeyEvent)

Toplevel.ProcessKey(KeyEvent)

Toplevel.ProcessHotKey(KeyEvent)

Toplevel.ProcessColdKey(KeyEvent)

Toplevel.PositionToplevel(Toplevel)

Toplevel.MouseEvent(MouseEvent)

Toplevel.WillPresent()

Toplevel.MoveNext()

Toplevel.MovePrevious()

Toplevel.RequestStop()

Toplevel.RequestStop(Toplevel)

Toplevel.PositionCursor()

Toplevel.GetTopMdiChild(Type, string[])

Toplevel.ShowChild(Toplevel)

Toplevel.OnEnter(View)

Toplevel.OnLeave(View)

Toplevel.Dispose(bool)

View.Added

View.Removed

View.Enter

View.Leave

View.MouseEnter

View.MouseLeave

View.MouseClick

View.CanFocusChanged

View.EnabledChanged

View.VisibleChanged

View.HotKeyChanged

View.HotKey

View.HotKeySpecifier

View.Shortcut

View.ShortcutTag

View.ShortcutAction

View.Data

View.Driver

View.Subviews

View.TabIndexes

View.TabIndex

View.TabStop

View.Id

View.IsCurrentTop

View.WantMousePositionReports

View.WantContinuousButtonPressed

View.Frame

View.LayoutStyle

View.Bounds

View.X

View.Y

View.Width

View.Height

View.ForceValidatePosDim

View.GetMinWidthHeight(out Size)

View.SetMinWidthHeight()

View.TextFormatter

View.SuperView

View.UpdateTextFormatterText()

View.ProcessResizeView()

View.SetNeedsDisplay()

View.ClearLayoutNeeded()

View.SetNeedsDisplay(Rect)

View.SetChildNeedsDisplay()

View.Add(params View[])

View.BringSubviewToFront(View)

View.SendSubviewToBack(View)

View.SendSubviewBackwards(View)

View.BringSubviewForward(View)

View.Clear()

View.Clear(Rect)

View.ScreenToView(int, int)

View.ClipToBounds()

View.SetClip(Rect)

View.DrawFrame(Rect, int, bool)

View.DrawHotString(ustring, Attribute, Attribute)

View.DrawHotString(ustring, bool, ColorScheme)

View.Move(int, int, bool)

View.HasFocus

View.OnAdded(View)

View.OnRemoved(View)

View.Focused

View.MostFocused

View.ColorScheme

View.AddRune(int, int, Rune)

View.ClearNeedsDisplay()

View.DrawContent

View.OnDrawContent(Rect)

View.DrawContentComplete

View.OnDrawContentComplete(Rect)

View.SetFocus()

View.KeyPress

View.InvokeKeybindings(KeyEvent)

View.AddKeyBinding(Key, params Command[])

View.ReplaceKeyBinding(Key, Key)

View.ContainsKeyBinding(Key)

View.ClearKeybindings()

View.ClearKeybinding(Key)

View.ClearKeybinding(params Command[])

View.AddCommand(Command, Func<bool?>)

View.GetSupportedCommands()

View.GetKeyFromCommand(params Command[])

View.KeyDown

View.KeyUp

View.EnsureFocus()

View.FocusFirst()

View.FocusLast()

View.FocusPrev()

View.FocusNext()

View.LayoutStarted

View.LayoutComplete

View.Initialized

View.LayoutSubviews()

View.AutoSize

View.PreserveTrailingSpaces

View.VerticalTextAlignment

View.TextDirection

View.IsInitialized

View.IsAdded

View.Enabled

View.ClearOnVisibleFalse

View.Visible

View.IgnoreBorderPropertyOnRedraw

View.ToString()

View.GetAutoSize()

View.GetHotKeySpecifierLength(bool)

View.GetTextFormatterBoundsSize()

View.GetBoundsTextFormatterSize()

View.OnMouseEnter(MouseEvent)

View.OnMouseLeave(MouseEvent)

View.OnMouseEvent(MouseEvent)

View.OnMouseClick(View.MouseEventArgs)

View.OnEnabledChanged()

View.OnVisibleChanged()

View.BeginInit()

View.EndInit()

View.SetWidth(int, out int)

View.SetHeight(int, out int)

View.GetCurrentWidth(out int)

View.GetCurrentHeight(out int)

View.GetNormalColor()

View.GetFocusColor()

View.GetHotNormalColor()

View.GetTopSuperView()

Responder.Dispose()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

The 'client area' of a Window is a rectangle deflated by one or more rows/columns from Bounds. A this time there is no API to determine this rectangle.

Constructors

Window(): Initializes a new instance of the Window class using Computed positioning.

Window(ustring): Initializes a new instance of the Window class with an optional title using Computed positioning.

Window(ustring, int, Border): Initializes a new instance of the Window using Computed positioning, and an optional title.

Window(Rect, ustring): Initializes a new instance of the Window class with an optional title using Absolute positioning.

Window(Rect, ustring, int, Border): Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, and an optional title.

Properties

Border

Text: The text displayed by the Label.

TextAlignment: Controls the text-alignment property of the label, changing it will redisplay the Label.

Title: The title to be displayed for this window.

Methods

Add(View): Adds a subview (child) to this view.

OnCanFocusChanged(): Method invoked when the CanFocus property from a view is changed.

OnTitleChanged(ustring, ustring): Called when the Title has been changed. Invokes the TitleChanged event.

OnTitleChanging(ustring, ustring): Called before the Title changes. Invokes the TitleChanging event, which can be cancelled.

Redraw(Rect): Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.

Remove(View): Removes a subview added via Add(View) or Add(params View[]) from this View.

RemoveAll(): Removes all subviews (children) added via Add(View) or Add(params View[]) from this View.

Events

TitleChanged: Event fired after the Title has been changed.