Interface ICursesBackend

Interface provides access to the Curses functionality. Use the Sharpie.Backend.NCursesBackend property to access the actual implementation.

Namespace: Sharpie.Abstractions

Assembly: sharpie.dll

Syntax

[PublicAPI]
public interface ICursesBackend

Methods

assume_default_colors(int, int)

Declaration

int assume_default_colors(int fgColor, int bgColor)

Parameters

Type	Name	Description
int	fgColor
int	bgColor

Returns

Type	Description
int

baudrate()

Declaration

int baudrate()

Returns

Type	Description
int

beep()

Declaration

int beep()

Returns

Type	Description
int

can_change_color()

Declaration

bool can_change_color()

Returns

Type	Description
bool

cbreak()

Declaration

int cbreak()

Returns

Type	Description
int

color_content(short, out short, out short, out short)

Declaration

int color_content(short color, out short red, out short green, out short blue)

Parameters

Type	Name	Description
short	color
short	red
short	green
short	blue

Returns

Type	Description
int

copywin(IntPtr, IntPtr, int, int, int, int, int, int, int)

Declaration

int copywin(IntPtr fromWindow, IntPtr toWindow, int srcStartLine, int srcStartCol, int destStartLine, int destStartCol, int destEndLine, int destEndCol, int overlay)

Parameters

Type	Name	Description
IntPtr	fromWindow
IntPtr	toWindow
int	srcStartLine
int	srcStartCol
int	destStartLine
int	destStartCol
int	destEndLine
int	destEndCol
int	overlay

Returns

Type	Description
int

curs_set(int)

Declaration

int curs_set(int level)

Parameters

Type	Name	Description
int	level

Returns

Type	Description
int

curses_version()

Declaration

string? curses_version()

Returns

Type	Description
string

delwin(IntPtr)

Declaration

int delwin(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

derwin(IntPtr, int, int, int, int)

Declaration

IntPtr derwin(IntPtr window, int lines, int cols, int beginLine, int beginCol)

Parameters

Type	Name	Description
IntPtr	window
int	lines
int	cols
int	beginLine
int	beginCol

Returns

Type	Description
IntPtr

doupdate()

Declaration

int doupdate()

Returns

Type	Description
int

dupwin(IntPtr)

Declaration

IntPtr dupwin(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
IntPtr

echo()

Declaration

int echo()

Returns

Type	Description
int

endwin()

Declaration

int endwin()

Returns

Type	Description
int

erasewchar(out uint)

Declaration

int erasewchar(out uint @char)

Parameters

Type	Name	Description
uint	char

Returns

Type	Description
int

flash()

Declaration

int flash()

Returns

Type	Description
int

getbegx(IntPtr)

Declaration

int getbegx(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

getbegy(IntPtr)

Declaration

int getbegy(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

getcchar(ComplexChar, StringBuilder, out VideoAttribute, out short, IntPtr)

Declaration

int getcchar(ComplexChar @char, StringBuilder dest, out VideoAttribute attributes, out short colorPair, IntPtr reserved)

Parameters

Type	Name	Description
ComplexChar	char
StringBuilder	dest
VideoAttribute	attributes
short	colorPair
IntPtr	reserved

Returns

Type	Description
int

getcurx(IntPtr)

Declaration

int getcurx(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

getcury(IntPtr)

Declaration

int getcury(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

getmaxx(IntPtr)

Declaration

int getmaxx(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

getmaxy(IntPtr)

Declaration

int getmaxy(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

getmouse(out CursesMouseState)

Declaration

int getmouse(out CursesMouseState state)

Parameters

Type	Name	Description
CursesMouseState	state

Returns

Type	Description
int

getparx(IntPtr)

Declaration

int getparx(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

getpary(IntPtr)

Declaration

int getpary(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

has_colors()

Declaration

bool has_colors()

Returns

Type	Description
bool

immedok(IntPtr, bool)

Declaration

void immedok(IntPtr window, bool set)

Parameters

Type	Name	Description
IntPtr	window
bool	set

init_color(short, short, short, short)

Declaration

int init_color(short color, short red, short green, short blue)

Parameters

Type	Name	Description
short	color
short	red
short	green
short	blue

Returns

Type	Description
int

init_pair(short, short, short)

Declaration

int init_pair(short colorPair, short fgColor, short bgColor)

Parameters

Type	Name	Description
short	colorPair
short	fgColor
short	bgColor

Returns

Type	Description
int

initscr()

Declaration

IntPtr initscr()

Returns

Type	Description
IntPtr

intrflush(IntPtr, bool)

Declaration

int intrflush(IntPtr window, bool set)

Parameters

Type	Name	Description
IntPtr	window
bool	set

Returns

Type	Description
int

is_immedok(IntPtr)

Declaration

bool is_immedok(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
bool

is_leaveok(IntPtr)

Declaration

bool is_leaveok(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
bool

is_linetouched(IntPtr, int)

Declaration

bool is_linetouched(IntPtr window, int line)

Parameters

Type	Name	Description
IntPtr	window
int	line

Returns

Type	Description
bool

is_scrollok(IntPtr)

Declaration

bool is_scrollok(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
bool

is_wintouched(IntPtr)

Declaration

bool is_wintouched(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
bool

key_name(uint)

Declaration

string? key_name(uint @char)

Parameters

Type	Name	Description
uint	char

Returns

Type	Description
string

keypad(IntPtr, bool)

Declaration

int keypad(IntPtr window, bool set)

Parameters

Type	Name	Description
IntPtr	window
bool	set

Returns

Type	Description
int

killwchar(out uint)

Declaration

int killwchar(out uint @char)

Parameters

Type	Name	Description
uint	char

Returns

Type	Description
int

leaveok(IntPtr, bool)

Declaration

int leaveok(IntPtr window, bool set)

Parameters

Type	Name	Description
IntPtr	window
bool	set

Returns

Type	Description
int

longname()

Declaration

string? longname()

Returns

Type	Description
string

meta(IntPtr, bool)

Declaration

int meta(IntPtr window, bool set)

Parameters

Type	Name	Description
IntPtr	window
bool	set

Returns

Type	Description
int

mouseinterval(int)

Declaration

int mouseinterval(int millis)

Parameters

Type	Name	Description
int	millis

Returns

Type	Description
int

mousemask(uint, out uint)

Declaration

int mousemask(uint newMask, out uint oldMask)

Parameters

Type	Name	Description
uint	newMask
uint	oldMask

Returns

Type	Description
int

mvderwin(IntPtr, int, int)

Declaration

int mvderwin(IntPtr window, int parentLine, int parentCol)

Parameters

Type	Name	Description
IntPtr	window
int	parentLine
int	parentCol

Returns

Type	Description
int

mvwin(IntPtr, int, int)

Declaration

int mvwin(IntPtr window, int toLine, int toCol)

Parameters

Type	Name	Description
IntPtr	window
int	toLine
int	toCol

Returns

Type	Description
int

newpad(int, int)

Declaration

IntPtr newpad(int lines, int cols)

Parameters

Type	Name	Description
int	lines
int	cols

Returns

Type	Description
IntPtr

newwin(int, int, int, int)

Declaration

IntPtr newwin(int lines, int cols, int atLine, int atCol)

Parameters

Type	Name	Description
int	lines
int	cols
int	atLine
int	atCol

Returns

Type	Description
IntPtr

nl()

Declaration

int nl()

Returns

Type	Description
int

nocbreak()

Declaration

int nocbreak()

Returns

Type	Description
int

nodelay(IntPtr, bool)

Declaration

int nodelay(IntPtr window, bool set)

Parameters

Type	Name	Description
IntPtr	window
bool	set

Returns

Type	Description
int

noecho()

Declaration

int noecho()

Returns

Type	Description
int

nonl()

Declaration

int nonl()

Returns

Type	Description
int

noqiflush()

Declaration

void noqiflush()

noraw()

Declaration

int noraw()

Returns

Type	Description
int

notimeout(IntPtr, bool)

Declaration

int notimeout(IntPtr window, bool set)

Parameters

Type	Name	Description
IntPtr	window
bool	set

Returns

Type	Description
int

overlay(IntPtr, IntPtr)

Declaration

int overlay(IntPtr srcWindow, IntPtr destWindow)

Parameters

Type	Name	Description
IntPtr	srcWindow
IntPtr	destWindow

Returns

Type	Description
int

overwrite(IntPtr, IntPtr)

Declaration

int overwrite(IntPtr srcWindow, IntPtr destWindow)

Parameters

Type	Name	Description
IntPtr	srcWindow
IntPtr	destWindow

Returns

Type	Description
int

pair_content(short, out short, out short)

Declaration

int pair_content(short colorPair, out short fgColor, out short bgColor)

Parameters

Type	Name	Description
short	colorPair
short	fgColor
short	bgColor

Returns

Type	Description
int

pnoutrefresh(IntPtr, int, int, int, int, int, int)

Declaration

int pnoutrefresh(IntPtr pad, int padMinLine, int padMinCol, int scrMinLine, int scrMinCol, int scrMaxLine, int scrMaxCol)

Parameters

Type	Name	Description
IntPtr	pad
int	padMinLine
int	padMinCol
int	scrMinLine
int	scrMinCol
int	scrMaxLine
int	scrMaxCol

Returns

Type	Description
int

prefresh(IntPtr, int, int, int, int, int, int)

Declaration

int prefresh(IntPtr pad, int padMinLine, int padMinCol, int scrMinLine, int scrMinCol, int scrMaxLine, int scrMaxCol)

Parameters

Type	Name	Description
IntPtr	pad
int	padMinLine
int	padMinCol
int	scrMinLine
int	scrMinCol
int	scrMaxLine
int	scrMaxCol

Returns

Type	Description
int

qiflush()

Declaration

void qiflush()

raw()

Declaration

int raw()

Returns

Type	Description
int

ripoffline(int, ripoffline_callback)

Declaration

int ripoffline(int lines, ICursesBackend.ripoffline_callback callback)

Parameters

Type	Name	Description
int	lines
ICursesBackend.ripoffline_callback	callback

Returns

Type	Description
int

scrollok(IntPtr, bool)

Declaration

int scrollok(IntPtr window, bool set)

Parameters

Type	Name	Description
IntPtr	window
bool	set

Returns

Type	Description
int

set_title(string)

Declaration

void set_title(string title)

Parameters

Type	Name	Description
string	title

setcchar(out ComplexChar, string, VideoAttribute, short, IntPtr)

Declaration

int setcchar(out ComplexChar @char, string text, VideoAttribute attributes, short colorPair, IntPtr reserved)

Parameters

Type	Name	Description
ComplexChar	char
string	text
VideoAttribute	attributes
short	colorPair
IntPtr	reserved

Returns

Type	Description
int

slk_attr(out VideoAttribute, out short)

Declaration

int slk_attr(out VideoAttribute attributes, out short colorPair)

Parameters

Type	Name	Description
VideoAttribute	attributes
short	colorPair

Returns

Type	Description
int

slk_attr_off(VideoAttribute, IntPtr)

Declaration

int slk_attr_off(VideoAttribute attributes, IntPtr reserved)

Parameters

Type	Name	Description
VideoAttribute	attributes
IntPtr	reserved

Returns

Type	Description
int

slk_attr_on(VideoAttribute, IntPtr)

Declaration

int slk_attr_on(VideoAttribute attributes, IntPtr reserved)

Parameters

Type	Name	Description
VideoAttribute	attributes
IntPtr	reserved

Returns

Type	Description
int

slk_attr_set(VideoAttribute, short, IntPtr)

Declaration

int slk_attr_set(VideoAttribute attributes, short colorPair, IntPtr reserved)

Parameters

Type	Name	Description
VideoAttribute	attributes
short	colorPair
IntPtr	reserved

Returns

Type	Description
int

slk_clear()

Declaration

int slk_clear()

Returns

Type	Description
int

slk_color(short)

Declaration

int slk_color(short colorPair)

Parameters

Type	Name	Description
short	colorPair

Returns

Type	Description
int

slk_init(int)

Declaration

int slk_init(int format)

Parameters

Type	Name	Description
int	format

Returns

Type	Description
int

slk_noutrefresh()

Declaration

int slk_noutrefresh()

Returns

Type	Description
int

slk_refresh()

Declaration

int slk_refresh()

Returns

Type	Description
int

slk_restore()

Declaration

int slk_restore()

Returns

Type	Description
int

slk_set(int, string, int)

Declaration

int slk_set(int labelIndex, string title, int align)

Parameters

Type	Name	Description
int	labelIndex
string	title
int	align

Returns

Type	Description
int

slk_touch()

Declaration

int slk_touch()

Returns

Type	Description
int

start_color()

Declaration

int start_color()

Returns

Type	Description
int

subpad(IntPtr, int, int, int, int)

Declaration

IntPtr subpad(IntPtr pad, int lines, int cols, int atLine, int atCol)

Parameters

Type	Name	Description
IntPtr	pad
int	lines
int	cols
int	atLine
int	atCol

Returns

Type	Description
IntPtr

syncok(IntPtr, bool)

Declaration

int syncok(IntPtr window, bool set)

Parameters

Type	Name	Description
IntPtr	window
bool	set

Returns

Type	Description
int

term_attrs(out VideoAttribute)

Declaration

int term_attrs(out VideoAttribute attributes)

Parameters

Type	Name	Description
VideoAttribute	attributes

Returns

Type	Description
int

termname()

Declaration

string? termname()

Returns

Type	Description
string

use_default_colors()

Declaration

int use_default_colors()

Returns

Type	Description
int

use_env(bool)

Declaration

void use_env(bool set)

Parameters

Type	Name	Description
bool	set

wadd_wch(IntPtr, ComplexChar)

Declaration

int wadd_wch(IntPtr window, ComplexChar @char)

Parameters

Type	Name	Description
IntPtr	window
ComplexChar	char

Returns

Type	Description
int

wattr_get(IntPtr, out VideoAttribute, out short, IntPtr)

Declaration

int wattr_get(IntPtr window, out VideoAttribute attributes, out short colorPair, IntPtr reserved)

Parameters

Type	Name	Description
IntPtr	window
VideoAttribute	attributes
short	colorPair
IntPtr	reserved

Returns

Type	Description
int

wattr_off(IntPtr, VideoAttribute, IntPtr)

Declaration

int wattr_off(IntPtr window, VideoAttribute attributes, IntPtr reserved)

Parameters

Type	Name	Description
IntPtr	window
VideoAttribute	attributes
IntPtr	reserved

Returns

Type	Description
int

wattr_on(IntPtr, VideoAttribute, IntPtr)

Declaration

int wattr_on(IntPtr window, VideoAttribute attributes, IntPtr reserved)

Parameters

Type	Name	Description
IntPtr	window
VideoAttribute	attributes
IntPtr	reserved

Returns

Type	Description
int

wattr_set(IntPtr, VideoAttribute, short, IntPtr)

Declaration

int wattr_set(IntPtr window, VideoAttribute attributes, short colorPair, IntPtr reserved)

Parameters

Type	Name	Description
IntPtr	window
VideoAttribute	attributes
short	colorPair
IntPtr	reserved

Returns

Type	Description
int

wbkgrnd(IntPtr, ComplexChar)

Declaration

int wbkgrnd(IntPtr window, ComplexChar @char)

Parameters

Type	Name	Description
IntPtr	window
ComplexChar	char

Returns

Type	Description
int

wborder(IntPtr, uint, uint, uint, uint, uint, uint, uint, uint)

Declaration

int wborder(IntPtr window, uint leftSide, uint rightSide, uint topSide, uint bottomSide, uint topLeftCorner, uint topRightCorner, uint bottomLeftCorner, uint bottomRightCorner)

Parameters

Type	Name	Description
IntPtr	window
uint	leftSide
uint	rightSide
uint	topSide
uint	bottomSide
uint	topLeftCorner
uint	topRightCorner
uint	bottomLeftCorner
uint	bottomRightCorner

Returns

Type	Description
int

wborder_set(IntPtr, ComplexChar, ComplexChar, ComplexChar, ComplexChar, ComplexChar, ComplexChar, ComplexChar, ComplexChar)

Declaration

int wborder_set(IntPtr window, ComplexChar leftSide, ComplexChar rightSide, ComplexChar topSide, ComplexChar bottomSide, ComplexChar topLeftCorner, ComplexChar topRightCorner, ComplexChar bottomLeftCorner, ComplexChar bottomRightCorner)

Parameters

Type	Name	Description
IntPtr	window
ComplexChar	leftSide
ComplexChar	rightSide
ComplexChar	topSide
ComplexChar	bottomSide
ComplexChar	topLeftCorner
ComplexChar	topRightCorner
ComplexChar	bottomLeftCorner
ComplexChar	bottomRightCorner

Returns

Type	Description
int

wchgat(IntPtr, int, VideoAttribute, short, IntPtr)

Declaration

int wchgat(IntPtr window, int count, VideoAttribute attributes, short colorPair, IntPtr reserved)

Parameters

Type	Name	Description
IntPtr	window
int	count
VideoAttribute	attributes
short	colorPair
IntPtr	reserved

Returns

Type	Description
int

wclrtobot(IntPtr)

Declaration

int wclrtobot(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

wclrtoeol(IntPtr)

Declaration

int wclrtoeol(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

wcolor_set(IntPtr, short, IntPtr)

Declaration

int wcolor_set(IntPtr window, short colorPair, IntPtr reserved)

Parameters

Type	Name	Description
IntPtr	window
short	colorPair
IntPtr	reserved

Returns

Type	Description
int

wdelch(IntPtr)

Declaration

int wdelch(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

werase(IntPtr)

Declaration

int werase(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

wget_event(IntPtr, int, out CursesEvent?)

Declaration

int wget_event(IntPtr window, int delay, out CursesEvent? @event)

Parameters

Type	Name	Description
IntPtr	window
int	delay
CursesEvent	event

Returns

Type	Description
int

wget_wch(IntPtr, out uint)

Declaration

int wget_wch(IntPtr window, out uint @char)

Parameters

Type	Name	Description
IntPtr	window
uint	char

Returns

Type	Description
int

wgetbkgrnd(IntPtr, out ComplexChar)

Declaration

int wgetbkgrnd(IntPtr window, out ComplexChar @char)

Parameters

Type	Name	Description
IntPtr	window
ComplexChar	char

Returns

Type	Description
int

whline(IntPtr, uint, int)

Declaration

int whline(IntPtr window, uint @char, int count)

Parameters

Type	Name	Description
IntPtr	window
uint	char
int	count

Returns

Type	Description
int

whline_set(IntPtr, ComplexChar, int)

Declaration

int whline_set(IntPtr window, ComplexChar @char, int count)

Parameters

Type	Name	Description
IntPtr	window
ComplexChar	char
int	count

Returns

Type	Description
int

win_wch(IntPtr, out ComplexChar)

Declaration

int win_wch(IntPtr window, out ComplexChar @char)

Parameters

Type	Name	Description
IntPtr	window
ComplexChar	char

Returns

Type	Description
int

winsdelln(IntPtr, int)

Declaration

int winsdelln(IntPtr window, int count)

Parameters

Type	Name	Description
IntPtr	window
int	count

Returns

Type	Description
int

wmove(IntPtr, int, int)

Declaration

int wmove(IntPtr window, int newLine, int newCol)

Parameters

Type	Name	Description
IntPtr	window
int	newLine
int	newCol

Returns

Type	Description
int

wnoutrefresh(IntPtr)

Declaration

int wnoutrefresh(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

wredrawln(IntPtr, int, int)

Declaration

int wredrawln(IntPtr window, int startLine, int lineCount)

Parameters

Type	Name	Description
IntPtr	window
int	startLine
int	lineCount

Returns

Type	Description
int

wrefresh(IntPtr)

Declaration

int wrefresh(IntPtr window)

Parameters

Type	Name	Description
IntPtr	window

Returns

Type	Description
int

wresize(IntPtr, int, int)

Declaration

int wresize(IntPtr window, int lines, int columns)

Parameters

Type	Name	Description
IntPtr	window
int	lines
int	columns

Returns

Type	Description
int

wscrl(IntPtr, int)

Declaration

int wscrl(IntPtr window, int count)

Parameters

Type	Name	Description
IntPtr	window
int	count

Returns

Type	Description
int

wtimeout(IntPtr, int)

Declaration

void wtimeout(IntPtr window, int delay)

Parameters

Type	Name	Description
IntPtr	window
int	delay

wtouchln(IntPtr, int, int, int)

Declaration

int wtouchln(IntPtr window, int line, int count, int changed)

Parameters

Type	Name	Description
IntPtr	window
int	line
int	count
int	changed

Returns

Type	Description
int

wvline(IntPtr, uint, int)

Declaration

int wvline(IntPtr window, uint @char, int count)

Parameters

Type	Name	Description
IntPtr	window
uint	char
int	count

Returns

Type	Description
int

wvline_set(IntPtr, ComplexChar, int)

Declaration

int wvline_set(IntPtr window, ComplexChar @char, int count)

Parameters

Type	Name	Description
IntPtr	window
ComplexChar	char
int	count

Returns

Type	Description
int