Class TerminalUI

An interface: a tree of elements, the element with keyboard focus, and the routing of input to them. It draws into a DarkEffekt.Terminal.CellSurface and takes input as events, so it runs unchanged as a surface program (DarkEffekt.Terminal.UI.UISurfaceProgram) or over escape sequences (DarkEffekt.Terminal.UI.UIAnsiProgram).

Tab and Shift+Tab move focus. A key goes to the focused element and then up through its ancestors until one uses it; a pointer event goes to the element under it the same way.

Assembly: DarkEffekt.Terminal.UI

Declaration

public sealed class TerminalUI : ITerminalInput

Implements:
DarkEffekt.Terminal.ITerminalInput

Properties

Colors

Declaration

public UIColors Colors { get; set; }

ScrollBarStyle

The glyphs every scroll bar draws unless it sets its own.

Declaration

public ScrollBarStyle ScrollBarStyle { get; set; }

Root

Declaration

public Element Root { get; set; }

Focus

The element with keyboard focus, or null.

Declaration

public Element Focus { get; }

NeedsRender

True when something changed since the last Render.

Declaration

public bool NeedsRender { get; }

UnhandledKey

A key no element used. Return true to stop the default Tab handling.

Declaration

public Func<TermKeyEvent, bool> UnhandledKey { get; set; }

CloseOnEscape

Close the interface on Esc, when no element and no UnhandledKey has used the key.

Declaration

public bool CloseOnEscape { get; set; }

Methods

Invalidate()

Declaration

public void Invalidate()

Close()

Asks the host to end the program.

Declaration

public void Close()

Update(float)

Declaration

public void Update(float deltaSeconds)

Parameters

Type	Name
System.Single	deltaSeconds

SetFocus(Element)

Gives an element keyboard focus. Null clears it.

Declaration

public void SetFocus(Element element)

Parameters

Type	Name
DarkEffekt.Terminal.UI.Element	element

Render(CellSurface)

Lays the tree out for a grid of this size and draws it.

Declaration

public void Render(CellSurface surface)

Parameters

Type	Name
DarkEffekt.Terminal.CellSurface	surface

GetSlots(List<SurfaceSlot>)

Adds the rectangle of every visible DarkEffekt.Terminal.UI.TextureView to the list.

Declaration

public void GetSlots(List<SurfaceSlot> into)

Parameters

Type	Name
System.Collections.Generic.List<DarkEffekt.Terminal.SurfaceSlot>	into

SetSlotBound(string, bool)

Records that the host shows a texture in the slot of this name, so the view there draws no caption.

Declaration

public void SetSlotBound(string name, bool bound)

Parameters

Type	Name
System.String	name
System.Boolean	bound

IsSlotBound(string)

Declaration

public bool IsSlotBound(string name)

Returns

System.Boolean

Parameters

Type	Name
System.String	name

FocusNext(int)

Moves focus forward (1) or back (-1) through the focusable elements, in tree order.

Declaration

public void FocusNext(int direction)

Parameters

Type	Name
System.Int32	direction

OnKey(in TermKeyEvent)

A non-text key: arrows, function keys, Enter, Tab, and the rest of DarkEffekt.Terminal.TermKey.

Declaration

public void OnKey(in TermKeyEvent e)

Parameters

Type	Name
DarkEffekt.Terminal.TermKeyEvent	e

OnChar(char, TermModifiers)

A typed character, or a letter held with Ctrl or Alt.

Declaration

public void OnChar(char c, TermModifiers modifiers)

Parameters

Type	Name
System.Char	c
DarkEffekt.Terminal.TermModifiers	modifiers

OnPaste(string)

Text pasted from the clipboard.

Declaration

public void OnPaste(string text)

Parameters

Type	Name
System.String	text

OnFocus(bool)

The terminal gained or lost keyboard focus.

Declaration

public void OnFocus(bool focused)

Parameters

Type	Name
System.Boolean	focused

OnMouse(in TermMouseEvent)

Declaration

public void OnMouse(in TermMouseEvent e)

Parameters

Type	Name
DarkEffekt.Terminal.TermMouseEvent	e

Events

Tick

Called every frame with the seconds since the last, before drawing. Animate here.

Declaration

public event Action<float> Tick

Event Type

System.Action<System.Single>

Closed

Raised by DarkEffekt.Terminal.UI.TerminalUI.Close(), for the program hosting the interface to end.

Declaration

public event Action Closed

Event Type

System.Action

Implements

• DarkEffekt.Terminal.ITerminalInput