Interface IScreen

Defines the traits that a Screen implements.

Inherited Members
Namespace: Sharpie.Abstractions
Assembly: sharpie.dll
Syntax
[PublicAPI]
public interface IScreen : ITerminalSurface, ISurface, IDrawSurface

Properties

Pads

Gets all child pads on this screen.

Declaration
IEnumerable<IPad> Pads { get; }
Property Value
Type Description
IEnumerable<IPad>
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.

Windows

Gets all child windows on this screen.

Declaration
IEnumerable<IWindow> Windows { get; }
Property Value
Type Description
IEnumerable<IWindow>
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.

Methods

Pad(Size)

Creates a new pad.

Declaration
IPad Pad(Size size)
Parameters
Type Name Description
Size size

The pad size.
Returns
Type Description
IPad

A new pad object.
Remarks

This operation is not thread safe.

Exceptions
Type Condition
ObjectDisposedException

Screen is no longer usable.
ArgumentOutOfRangeException

The size is invalid.
CursesSynchronizationException

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

Window(Rectangle)

Creates a new sub-window in the parent window.

Declaration
IWindow Window(Rectangle area)
Parameters
Type Name Description
Rectangle area

The area of the window to put the sub-window in.
Returns
Type Description
IWindow

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