Class BlockBuilder

Namespace

MiniTui

Assembly

MiniTui.dll

A border with optional titles and padding, drawn around other widgets.

public sealed class BlockBuilder

Inheritance

object

BlockBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

var inner = Widget.Block().Title(" Services ").Focused().Draw(buf, area);

Methods

BorderStyle(Style)

A style patched over the theme's border style.

public BlockBuilder BorderStyle(Style style)

Parameters

style Style

Returns

BlockBuilder

BorderType(BoxStyle)

The border glyphs. The default is Single.

public BlockBuilder BorderType(BoxStyle type)

Parameters

type BoxStyle

Returns

BlockBuilder

Borders(Borders)

Which sides have a border. The default is All.

public BlockBuilder Borders(Borders borders)

Parameters

borders Borders

Returns

BlockBuilder

Draw(Buffer, Rect)

Draw the block.

public Rect Draw(Buffer buf, Rect area)

Parameters

buf Buffer

area Rect

Returns

Rect

The inner area, the same as Inner(Rect).

Focused(bool)

Draw with the focused border and title styles.

public BlockBuilder Focused(bool focused = true)

Parameters

focused bool

Returns

BlockBuilder

Inner(Rect)

The area inside the borders, titles and padding, without drawing.

public Rect Inner(Rect area)

Parameters

area Rect

Returns

Rect

Padding(Margin)

Space between the border and the inner area.

public BlockBuilder Padding(Margin padding)

Parameters

padding Margin

Returns

BlockBuilder

Style(Style)

A style patched over the whole area, including the inside.

public BlockBuilder Style(Style style)

Parameters

style Style

Returns

BlockBuilder

Title(Line?)

A title in the top border.

public BlockBuilder Title(Line? title)

Parameters

title Line

Returns

BlockBuilder

TitleAlignment(Alignment)

Where the titles sit. The default is Left.

public BlockBuilder TitleAlignment(Alignment alignment)

Parameters

alignment Alignment

Returns

BlockBuilder

TitleBottom(Line?)

A title in the bottom border.

public BlockBuilder TitleBottom(Line? title)

Parameters

title Line

Returns

BlockBuilder

TitleStyle(Style)

A style patched over the theme's title style.

public BlockBuilder TitleStyle(Style style)

Parameters

style Style

Returns

BlockBuilder