Class SubWindow

Represents a Curses sub-window and contains all it's functionality.

Inheritance

object

Surface

SubWindow

Implements

IDisposable

ISubWindow

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()

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 SubWindow : Surface, IDisposable, ISubWindow, ISurface, IDrawSurface

Properties

Location

Gets or sets the location of the sub-window within its parent window.

Declaration

public Point Location { get; set; }

Property Value

Type	Description
Point

Remarks

This operation is not thread safe.

Exceptions

Type	Condition
ArgumentOutOfRangeException	The value is outside the parent's 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.

Origin

Returns the value of Location.

Declaration

protected override Point Origin { get; }

Property Value

Type	Description
Point

Overrides

Surface.Origin

Exceptions

Type	Condition
CursesOperationException	A Curses error occurred.

Size

Gets or sets the size of the sub-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.

Window

The parent window of this sub-window.

Declaration

public Window Window { get; }

Property Value

Type	Description
Window

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 this sub-window, including its attributes.

Declaration

public ISubWindow Duplicate()

Returns

Type	Description
ISubWindow	A new window 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.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

Surface.ToString()

Implements

IDisposable

ISubWindow

ISurface

IDrawSurface