Skip to content
ConsoleMonster

API Reference

Class

LiveWidget

Edit on GitHub
Namespace ConsoleMonster.Widgets
Assembly ConsoleMonster
Source LiveWidget.cs:34
Implements
IWidget ILiveTarget
Modifiers abstract

Base class for widgets that accept live updates. State is mutated only through LiveWidget.Apply, which a live session calls on its render thread; typed handles post events from any thread.

Inheritance

  • Object
  • LiveWidget

Methods

public abstract Void Apply(LiveEvent liveEvent) #
Returns: Void

Applies an event to the widget's state.

Parameters

liveEvent ConsoleMonster.Live.LiveEvent requiredposition: 0
The event.
public virtual String? Describe(LiveEvent liveEvent) #
LiveWidget.cs:34
Returns: String?

Returns a line describing the event for line-based outputs (Stream/Plain), or null when the event is not worth a line (for example a single counter increment). Called after ILiveTarget.Apply.

Parameters

liveEvent ConsoleMonster.Live.LiveEvent requiredposition: 0
The event that was applied.

Returns

A plain line or null.

public abstract Size Measure(Constraints constraints, RenderContext context) #
Returns: Size

Returns the size the widget wants within the constraints.

Parameters

constraints ConsoleMonster.Layout.Constraints requiredposition: 0
The space offered.
context ConsoleMonster.Canvas.RenderContext requiredposition: 1
Profile, theme and glyphs.

Returns

The desired size, never larger than the constraints.

public abstract Void Render(Region region, RenderContext context) #
Returns: Void

Renders into a region. The region may be smaller or larger than the measured size.

Parameters

region ConsoleMonster.Canvas.Region requiredposition: 0
The target region.
context ConsoleMonster.Canvas.RenderContext requiredposition: 1
Profile, theme and glyphs.

Properties

public String Name { get; } #
LiveWidget.cs:22

The unique name events are addressed to.