Class ParagraphBuilder

Namespace

MiniTui

Assembly

MiniTui.dll

Multi-line text with optional wrapping, alignment and scrolling.

public sealed class ParagraphBuilder

Inheritance

object

ParagraphBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Alignment(Alignment)

The alignment of lines that don't set their own.

public ParagraphBuilder Alignment(Alignment alignment)

Parameters

alignment Alignment

Returns

ParagraphBuilder

Block(BlockBuilder)

Draw a block around the text.

public ParagraphBuilder Block(BlockBuilder block)

Parameters

block BlockBuilder

Returns

ParagraphBuilder

Draw(Buffer, Rect)

Draw the paragraph.

public void Draw(Buffer buf, Rect area)

Parameters

buf Buffer

area Rect

Scroll(int)

Skip this many rows from the top.

public ParagraphBuilder Scroll(int rows)

Parameters

rows int

Returns

ParagraphBuilder

State(ScrollState)

Scroll with a state the paragraph keeps in range, and show a scrollbar when the text overflows.

public ParagraphBuilder State(ScrollState state)

Parameters

state ScrollState

Returns

ParagraphBuilder

Style(Style)

A style patched over the theme's text style.

public ParagraphBuilder Style(Style style)

Parameters

style Style

Returns

ParagraphBuilder

Text(Text)

The text. A string is split into lines at line breaks.

public ParagraphBuilder Text(Text text)

Parameters

text Text

Returns

ParagraphBuilder

Wrap(WrapMode)

How long lines break. The default is None.

public ParagraphBuilder Wrap(WrapMode wrap)

Parameters

wrap WrapMode

Returns

ParagraphBuilder