Class InlineActivityOverlay

Namespace

ItTiger.TigerCli.Tui.Abstractions

Assembly

ItTiger.TigerCli.dll

Describes a time-varying overlay an inline control exposes to its hosting InlineDialog. The dialog adds it to the grid once (through the normal CliGrid.AddOverlay system) and never rebuilds the grid when the content changes — the overlay's renderer reads the live Ticker on every render, so animation rides on the cached grid. Placement is given relative to a dialog Area, matching how widgets are placed, so controls never depend on absolute grid coordinates. The overlay is a horizontal strip on the area's row, running from ColumnOffset to the end of the area.

public sealed class InlineActivityOverlay

Inheritance

object

InlineActivityOverlay

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This is placement/animation metadata only. The dialog derives the actual CliOverlay renderer from the ticker: while the ticker is active it writes CurrentContent, optionally passed through ContentFormatter for overlay-specific presentation; while inactive it renders nothing, leaving the underlying cells intact — the same visibility model as the scroll overlays. MaxLength is the control's content contract: formatted content may be shorter, but content wider than MaxLength is a usage error the dialog fails loudly on (it never truncates or silently hides declared-oversize content). Content within the contract that still does not fit the measured strip (a very narrow dialog) renders nothing for that frame.

Properties

Area

The dialog area whose row the overlay is anchored to.

public required InlineDialogArea Area { get; init; }

Property Value

InlineDialogArea

ColumnOffset

Column offset from the area's start column at which the overlay begins.

public int ColumnOffset { get; init; }

Property Value

int

ContentFormatter

Optional overlay-only presentation applied to the ticker's raw content.

public Func<string, string>? ContentFormatter { get; init; }

Property Value

Func<string, string>

MaxLength

Maximum number of screen cells the formatted content may occupy. Rendered content may be shorter; producing wider content is a usage error (the hosting dialog throws at render time).

public required int MaxLength { get; init; }

Property Value

int

Style

Uniform character style applied to the overlay's content.

public CliCharStyle Style { get; init; }

Property Value

CliCharStyle

Ticker

The time-driven content source the overlay renders.

public required TuiTicker Ticker { get; init; }

Property Value

TuiTicker