Interface IPad

Describes the traits specific to the Pad.

Inherited Members

ISurface.Handle

ISurface.Disposed

ISurface.Scrollable

ISurface.Style

ISurface.ColorMixture

ISurface.Background

ISurface.CaretLocation

ISurface.Dirty

ISurface.ManagedCaret

ISurface.EnableAttributes(VideoAttribute)

ISurface.DisableAttributes(VideoAttribute)

ISurface.ScrollUp(int)

ISurface.ScrollDown(int)

ISurface.InsertEmptyLines(int)

ISurface.DeleteLines(int)

ISurface.ChangeTextStyle(int, Style)

ISurface.WriteText(StyledText, bool)

ISurface.WriteText(string, Style, bool)

ISurface.WriteText(string, bool)

ISurface.NextLine()

ISurface.DrawText(IAsciiFont, string, Style, bool, bool)

ISurface.DrawText(IAsciiFont, string, bool, bool)

ISurface.DrawVerticalLine(int, Rune, Style)

ISurface.DrawVerticalLine(int)

ISurface.DrawHorizontalLine(int, Rune, Style)

ISurface.DrawHorizontalLine(int)

ISurface.DrawBorder(Rune, Rune, Rune, Rune, Rune, Rune, Rune, Rune, Style)

ISurface.DrawBorder()

ISurface.RemoveText(int)

ISurface.GetText(int)

ISurface.Clear(ClearStrategy)

ISurface.Replace(ISurface, ReplaceStrategy)

ISurface.Replace(ISurface, Rectangle, Point, ReplaceStrategy)

ISurface.MarkDirty(int, int)

ISurface.MarkDirty()

ISurface.IsPointWithin(Point)

ISurface.IsRectangleWithin(Rectangle)

ISurface.Draw(Point, Rectangle, IDrawable)

ISurface.Draw(Point, IDrawable)

ISurface.LineDirty(int)

ISurface.Destroy()

IDrawSurface.DrawCell(Point, Rune, Style)

Namespace: Sharpie.Abstractions

Assembly: sharpie.dll

Syntax

[PublicAPI]
public interface IPad : ISurface, IDrawSurface

Properties

Screen

The parent screen of this pad.

Declaration

IScreen Screen { get; }

Property Value

Type	Description
IScreen

Size

Gets or sets the size of the window.

Declaration

Size Size { get; set; }

Property Value

Type	Description
Size

Remarks

This operation is not thread safe.

Exceptions

Type	Condition
ArgumentOutOfRangeException	The value is outside the bounds.
ObjectDisposedException	Window is no longer usable.
CursesSynchronizationException	Thrown if this operation was expected to run on the main thread/context but wasn't.

SubPads

Gets the sub-pads of this pad.

Declaration

IEnumerable<ISubPad> SubPads { get; }

Property Value

Type	Description
IEnumerable<ISubPad>

Remarks

This operation is not thread safe.

Exceptions

Type	Condition
CursesSynchronizationException	Thrown if this operation was expected to run on the main thread/context but wasn't.

Methods

Duplicate()

Duplicates and existing pad, including its attributes.

Declaration

IPad Duplicate()

Returns

Type	Description
IPad	A new pad object.

Remarks

This operation is not thread safe.

Exceptions

Type	Condition
ObjectDisposedException	Screen is no longer usable.
CursesSynchronizationException	Thrown if this operation was expected to run on the main thread/context but wasn't.

Refresh(Point)

Redraws an area of the screen with the contents of the pad.

Declaration

void Refresh(Point destLocation)

Parameters

Type	Name	Description
Point	destLocation	The point on the screen to place that rectangle.

Remarks

This operation is not thread safe.

Exceptions

Type	Condition
ObjectDisposedException	The terminal of the given window have been disposed.
ArgumentOutOfRangeException	Thrown if destLocation is out of bounds.
CursesSynchronizationException	Thrown if this operation was expected to run on the main thread/context but wasn't.

Refresh(Rectangle, Point)

Redraws an area of the screen with the contents of the pad.

Declaration

void Refresh(Rectangle srcArea, Point destLocation)

Parameters

Type	Name	Description
Rectangle	srcArea	The rectangle of the pad to place onto the screen.
Point	destLocation	The point on the screen to place that rectangle.

Remarks

This operation is not thread safe.

Exceptions

Type	Condition
ObjectDisposedException	The terminal of the given window have been disposed.
CursesSynchronizationException	Thrown if this operation was expected to run on the main thread/context but wasn't.

SubPad(Rectangle)

Creates a new sub-pad in the parent pad.

Declaration

ISubPad SubPad(Rectangle area)

Parameters

Type	Name	Description
Rectangle	area	The area of the pad to put the sub-pad in.

Returns

Type	Description
ISubPad	A new pad object.

Exceptions

Type	Condition
ObjectDisposedException	Screen is no longer usable.
ArgumentOutOfRangeException	The area is outside the bounds of the parent.
CursesSynchronizationException	Thrown if this operation was expected to run on the main thread/context but wasn't.