Class CliOverlay

Namespace

ItTiger.TigerCli.Primitives

Assembly

ItTiger.TigerCli.dll

A post-layout, one-dimensional strip that can overwrite measured cells in a CliGrid after the standard measurement pass.

public class CliOverlay

Inheritance

object

CliOverlay

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CliOverlay(CliPoint, CliOrientation, int, CliCharStyle, CliOverlayRenderer)

Creates an overlay whose renderer supplies uniformly styled characters.

public CliOverlay(CliPoint start, CliOrientation orientation, int logicalLength, CliCharStyle style, CliOverlayRenderer renderer)

Parameters

start CliPoint

The starting grid coordinate in column, row order.

orientation CliOrientation

The direction in which the overlay extends.

logicalLength int

The number of grid cells covered by the overlay.

style CliCharStyle

The style applied to rendered characters.

renderer CliOverlayRenderer

The delegate that supplies the overlay characters.

CliOverlay(CliPoint, CliOrientation, int, CliCharStyle, CliStyledOverlayRenderer)

Creates an overlay whose renderer can style individual characters.

public CliOverlay(CliPoint start, CliOrientation orientation, int logicalLength, CliCharStyle style, CliStyledOverlayRenderer renderer)

Parameters

start CliPoint

The starting grid coordinate in column, row order.

orientation CliOrientation

The direction in which the overlay extends.

logicalLength int

The number of grid cells covered by the overlay.

style CliCharStyle

The base style used by glyphs without a per-character style.

renderer CliStyledOverlayRenderer

The delegate that supplies the styled overlay glyphs.

Properties

LogicalLength

Number of grid cells covered by the overlay.

public int LogicalLength { get; }

Property Value

int

Orientation

Whether the overlay runs along rows (Vertical, shape 1 × m) or along columns (Horizontal, shape n × 1).

public CliOrientation Orientation { get; }

Property Value

CliOrientation

Renderer

Delegate that produces the actual characters to render, or null when the overlay was created from a CliStyledOverlayRenderer. Application always goes through the unified ItTiger.TigerCli.Primitives.CliOverlay.StyledRenderer; this property is retained for source compatibility.

public CliOverlayRenderer? Renderer { get; }

Property Value

CliOverlayRenderer

Start

Grid cell at which the overlay begins (column, row).

public CliPoint Start { get; }

Property Value

CliPoint

Style

Base character style applied to every character the overlay writes that does not carry its own per-character style. For a plain CliOverlayRenderer this is the uniform style of the whole overlay; for a CliStyledOverlayRenderer it is the fallback used wherever a glyph's Style is null.

public CliCharStyle Style { get; }

Property Value

CliCharStyle