Class Pad

Represents a Curses pad, which is a special type of off-screen window.

Inheritance

object

Surface

Pad

Implements

IDisposable

IPad

ISurface

IDrawSurface

Inherited Members

Surface.Dispose()

Surface.Handle

Surface.ManagedCaret

Surface.Scrollable

Surface.Disposed

Surface.Style

Surface.ColorMixture

Surface.Background

Surface.CaretLocation

Surface.Dirty

Surface.LineDirty(int)

Surface.EnableAttributes(VideoAttribute)

Surface.DisableAttributes(VideoAttribute)

Surface.ScrollUp(int)

Surface.ScrollDown(int)

Surface.InsertEmptyLines(int)

Surface.DeleteLines(int)

Surface.ChangeTextStyle(int, Style)

Surface.WriteText(StyledText, bool)

Surface.WriteText(string, Style, bool)

Surface.WriteText(string, bool)

Surface.NextLine()

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

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

Surface.DrawVerticalLine(int, Rune, Style)

Surface.DrawVerticalLine(int)

Surface.DrawHorizontalLine(int, Rune, Style)

Surface.DrawHorizontalLine(int)

Surface.DrawBorder(Rune, Rune, Rune, Rune, Rune, Rune, Rune, Rune, Style)

Surface.DrawBorder()

Surface.RemoveText(int)

Surface.GetText(int)

Surface.Clear(ClearStrategy)

Surface.Replace(ISurface, ReplaceStrategy)

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

Surface.MarkDirty(int, int)

Surface.MarkDirty()

Surface.IsPointWithin(Point)

Surface.IsRectangleWithin(Rectangle)

Surface.Draw(Point, Rectangle, IDrawable)

Surface.Draw(Point, IDrawable)

Surface.Destroy()

Surface.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Sharpie

Assembly: sharpie.dll

Syntax

[PublicAPI]
public sealed class Pad : Surface, IDisposable, IPad, ISurface, IDrawSurface

Properties

Screen

The parent screen of this pad.

Declaration

public Screen Screen { get; }

Property Value

Type	Description
Screen

Size

Gets or sets the size of the window.

Declaration

public 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.
CursesOperationException	A Curses error occurred.

SubPads

Gets the sub-pads of this pad.

Declaration

public 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

AssertSynchronized()

Asserts that executing thread is bound to the correct synchronization context.

Declaration

protected override void AssertSynchronized()

Overrides

Surface.AssertSynchronized()

Exceptions

Type	Condition
CursesSynchronizationException	Thrown if current thread is not bound to the correct context.

Delete()

Deletes the surface from the curses backend.

Declaration

protected override void Delete()

Overrides

Surface.Delete()

Duplicate()

Duplicates and existing pad, including its attributes.

Declaration

public 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.
CursesOperationException	A Curses error occurred.

Refresh(Point)

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

Declaration

public 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.
CursesOperationException	A Curses error occurred.

Refresh(Rectangle, Point)

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

Declaration

public 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.
CursesOperationException	A Curses error occurred.

SubPad(Rectangle)

Creates a new sub-pad in the parent pad.

Declaration

public 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.
CursesOperationException	A Curses error occurred.

Implements

IDisposable

IPad

ISurface

IDrawSurface