Skip to content
TerminalBy DarkEffekt

Class LogView

Lines of text that scroll as more arrive, newest at the bottom. The wheel and the bar scroll back through the lines kept; a view scrolled to the newest line follows as more arrive.

Assembly: DarkEffekt.Terminal.UI
Section titled “Assembly: DarkEffekt.Terminal.UI”
Declaration
public sealed class LogView : Element

Inheritance: System.Object -> DarkEffekt.Terminal.UI.Element

Properties

Section titled “Properties”

Wrap

Section titled “Wrap”

Where a line too wide for the view breaks. A wrapped line takes as many rows as it needs.

Declaration
public TextWrap Wrap { get; set; }

Capacity

Section titled “Capacity”

The most lines kept; older ones are dropped.

Declaration
public int Capacity { get; set; }

ScrollBar

Section titled “ScrollBar”

When the bar at the right edge shows. Hidden by default: a log overflows by nature, and the wheel scrolls back without one.

Declaration
public ScrollBarMode ScrollBar { get; set; }

ScrollBarStyle

Section titled “ScrollBarStyle”

The bar’s glyphs. Null takes the interface’s DarkEffekt.Terminal.UI.TerminalUI.ScrollBarStyle.

Declaration
public ScrollBarStyle ScrollBarStyle { get; set; }

WheelStep

Section titled “WheelStep”

The cells one wheel notch moves.

Declaration
public int WheelStep { get; set; }

Count

Section titled “Count”
Declaration
public int Count { get; }

ChildCount

Section titled “ChildCount”
Declaration
public override int ChildCount { get; }

Methods

Section titled “Methods”

GetChild(int)

Section titled “GetChild(int)”
Declaration
public override Element GetChild(int index)
Returns
Section titled “Returns”

DarkEffekt.Terminal.UI.Element

Parameters
Section titled “Parameters”
Type Name
System.Int32 index

Add(string)

Section titled “Add(string)”
Declaration
public void Add(string line)
Parameters
Section titled “Parameters”
Type Name
System.String line

Clear()

Section titled “Clear()”
Declaration
public void Clear()

ScrollToEnd()

Section titled “ScrollToEnd()”

Scrolls to the newest line, so the view follows the log again.

Declaration
public void ScrollToEnd()

MeasureCore(CellSize)

Section titled “MeasureCore(CellSize)”

The size this element wants, within the room given.

Declaration
protected override CellSize MeasureCore(CellSize available)
Returns
Section titled “Returns”

DarkEffekt.Terminal.UI.CellSize

Parameters
Section titled “Parameters”
Type Name
DarkEffekt.Terminal.UI.CellSize available

ArrangeCore(CellRect)

Section titled “ArrangeCore(CellRect)”

Places the children inside this element’s rectangle.

Declaration
protected override void ArrangeCore(CellRect rect)
Parameters
Section titled “Parameters”
Type Name
DarkEffekt.Terminal.UI.CellRect rect

RenderCore(CellCanvas)

Section titled “RenderCore(CellCanvas)”
Declaration
protected override void RenderCore(CellCanvas canvas)
Parameters
Section titled “Parameters”
Type Name
DarkEffekt.Terminal.UI.CellCanvas canvas

OnMouse(in TermMouseEvent)

Section titled “OnMouse(in TermMouseEvent)”

A pointer event on this element. Return true when it was used.

Declaration
public override bool OnMouse(in TermMouseEvent e)
Returns
Section titled “Returns”

System.Boolean

Parameters
Section titled “Parameters”
Type Name
DarkEffekt.Terminal.TermMouseEvent e