Class `curses.window`

Curses Window objects.

The methods documented on this page are available on any Curses Window object, such as created by:

stdscr = curses.initscr ()
window = curses.newwin (25, 80, 0, 0)

Methods

curses.window:addch (ch)	Advance the cursor after writing a character at the old position.
curses.window:addchstr (chstr[, n])	Copy a curses.chstr starting at the current cursor position.
curses.window:addstr (str[, n])	Copy a Lua string starting at the current cursor position.
curses.window:attroff (attrs)	Turn off the given attributes for subsequent writes to the window.
curses.window:attron (attrs)	Turn on the given attributes for subsequent writes to the window.
curses.window:attrset (attrs)	Set the given attributes for subsequent writes to the window.
curses.window:border ([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])	Draw a border around a window.
curses.window:box (verch, horch)	Draw a box around a window.
curses.window:clear ()	Call erase and then clearok.
curses.window:clearok (bf)	The next call to refresh will clear and completely redraw the window.
curses.window:clone ()	Make a duplicate of a window.
curses.window:close ()	Free all the resources associated with a window.
curses.window:clrtobot ()	Write blanks to every character position after the cursor.
curses.window:clrtoeol ()	Write blanks from the cursor to the end of the current line.
curses.window:copywin (dst, st, sl, dt, dl, db, dr, overlay)	Overlay a rectangle of this window over another.
curses.window:cursyncup ()	Mark cursor position of ancestors of a window for refresh.
curses.window:delch ()	Delete the character under the cursor.
curses.window:deleteln ()	Move the lines below the cursor up, to delete the current line.
curses.window:derive (nlines, ncols, begin_y, begin_x)	Create a new derived window.
curses.window:echoch (ch)	Call addch then refresh.
curses.window:erase ()	Write blanks to every character position in the window.
curses.window:getbegyx ()	Fetch the absolute top-left coordinates of a window.
curses.window:getbkgd ()	Fetch the current background attribute for the window.
curses.window:getch ()	Read a character from the window input.
curses.window:getmaxyx ()	Fetch the absolute bottom-right coordinates of a window.
curses.window:getparyx ()	Fetch the parent-relative coordinates of a subwindow.
curses.window:getstr ([n])	Read characters up to the next newline from the window input.
curses.window:getyx ()	Fetch the cursor position.
curses.window:hline (ch, n)	Draw a row of characters from the current cursor position.
curses.window:idcok (bf)	Use hardware character insert and delete on supporting terminals.
curses.window:idlok (bf)	Use hardware line insert and delete on supporting terminals.
curses.window:immedok (bf)	Automatically call refresh whenever the window content is changed.
curses.window:insertln ()	Move the current line and those below down one line, leaving a new blank line.
curses.window:intrflush (bf)	Set the flush on interrupt behaviour for the window.
curses.window:is_linetouched (line)	Has a particular window line changed since the last refresh?
curses.window:is_wintouched ()	Has a window changed since the last refresh?
curses.window:keypad ([on])	Set the single value keypad keys behaviour for the window.
curses.window:leaveok (bf)	No need to force synchronisation of hardware cursor.
curses.window:meta (on)	Force 8-bit (or 7-bit) input characters for the window.
curses.window:move (y, x)	Change the cursor position.
curses.window:move_derived (par_y, par_x)	Move the position of a derived window.
curses.window:move_window (y, x)	Move the position of a window.
curses.window:mvaddch (y, x, ch)	Call move, then addch.
curses.window:mvaddchstr (y, x[, n])	Call move then addchstr.
curses.window:mvaddstr (y, x, str[, n])	Call move then addstr.
curses.window:mvdelch (y, x)	Call move then delch.
curses.window:mvgetch (y, x)	Call move then getch
curses.window:mvgetstr (y, x[, n=-1])	Call move then getstr.
curses.window:mvhline (y, x, ch, n)	Move the cursor, then draw a row of characters from the new cursor position.
curses.window:mvvline (y, x, ch, n)	Move the cursor, then draw a column of characters from the new cursor position.
curses.window:mvwinch (y, x)	Call move then winch
curses.window:mvwinchnstr (y, x, n)	Call move then winchnstr.
curses.window:mvwinnstr (y, x, n)	Call move then winnstr.
curses.window:mvwinsch (y, x, ch)	Call move then winsch.
curses.window:mvwinsnstr (y, x, str, n)	Call move then winsnstr.
curses.window:mvwinsstr (y, x, str)	Call move then winsstr.
curses.window:nodelay (on)	Force getch to be non-blocking.
curses.window:notimeout (bf)	Return input immediately from this window.
curses.window:noutrefresh ()	Copy the window backing screen to the virtual screen.
curses.window:overlay (dst)	Overlay this window on top of another non-destructively.
curses.window:overwrite (dst)	Destructively overwrite another window with this one.
curses.window:pechochar (ch)	An efficient equivalent to addch followed by refresh.
curses.window:pnoutrefresh (st, sl, dt, dl, db, dr)	Equivalent to noutrefresh for use with pad windows.
curses.window:prefresh (st, sl, dt, dl, db, dr)	Equivalent to refresh for use with pad windows.
curses.window:redrawln (beg_line, num_lines)	Mark a range of lines in a window as corrupted and in need of redrawing.
curses.window:redrawwin ()	Mark a window as having corrupted display that needs fully redrawing.
curses.window:refresh ()	Refresh the window terminal display from the virtual screen.
curses.window:resize (height, width)	Change the size of a window.
curses.window:scrl (n)	Scroll the window up n lines.
curses.window:scrollok (bf)	Scroll up one line when the cursor writes to the last screen position.
curses.window:standend ()	Turn off all attributes for subsequent writes to the window.
curses.window:standout ()	Set `A_STANDOUT` for subsequent writes to the window.
curses.window:sub (nlines, ncols, begin_y, begin_x)	Create a new subwindow.
curses.window:subpad (nlines, ncols, begin_y, begin_x)	Return a new subpad window object.
curses.window:syncdown ()	Mark child windows for refresh.
curses.window:syncok (bf)	Automatically mark ancestors of a changed window for refresh.
curses.window:syncup ()	Mark ancestors of a window for refresh.
curses.window:timeout (delay)	For differentiating user input from terminal control sequences.
curses.window:touch ([changed])	Set the changed state of a window since the last refresh.
curses.window:touchline (y, n[, changed])	Mark a range of lines as changed since the last refresh.
curses.window:vline (ch, n)	Draw a column of characters from the current cursor position.
curses.window:wbkgd (ch)	Call wbkgdset and then set the background of every position accordingly.
curses.window:wbkgdset (ch)	Set the background attributes for subsequently written characters.
curses.window:winch ()	Fetch the attributed character at the current cursor position.
curses.window:winchnstr (n)	Fetch attributed characters from cursor position up to rightmost window position.
curses.window:winnstr (n)	Fetch a string from cursor position up to rightmost window position.
curses.window:winsch (ch)	Insert an attributed character before the current cursor position.
curses.window:winsdelln (n)	Call deleteln n times.
curses.window:winsnstr (str, n)	Like winsstr, but no more than n characters.
curses.window:winsstr (str)	Insert a string of characters before the current cursor position.
curses.window:wsetscrreg (top, bot)	Set a software scrolling region for the window.

Metamethods

curses.window:__tostring ()

Unique string representation of a curses.window.

Methods

curses.window:addch (ch)

Advance the cursor after writing a character at the old position.

Parameters:

ch int

Returns:

bool

true

Parameters:

chstr int cs
n int (optional)

Returns:

bool

true

Parameters:

str string
n int (optional)

Returns:

bool

true

Parameters:

attrs int

Returns:

bool

true

Parameters:

attrs int

Returns:

bool

true

Parameters:

attrs int

Returns:

bool

true

Parameters:

ls int (optional)
rs int (optional)
ts int (optional)
bs int (optional)
tl int (optional)
tr int (optional)
bl int (optional)
br int (optional)

Returns:

bool

true

Usage:

  win:border (curses.ACS_VLINE, curses.ACS_VLINE,
              curses.ACS_HLINE, curses.ACS_HLINE,
	      curses.ACS_ULCORNER, curses.ACS_URCORNER,
	      curses.ACS_LLCORNER, curses.ACS_LRCORNER)

curses.window:box (verch, horch)

Draw a box around a window.

Parameters:

verch int
horch int

Returns:

bool

true

Usage:

win:box (curses.ACS_VLINE, curses.ACS_HLINE)

curses.window:clear ()

Call erase and then clearok.

Returns:

bool

true

Parameters:

bf bool

Returns:

bool

true

Returns:

window

Returns:

bool

true

Returns:

bool

true

Parameters:

dst window destination window
st int top row from this window
sl int left column from this window
dt int top row of rectangle
dl int left column of rectangle
db int bottom row of rectangle
dr int right column of rectangle
overlay bool if true, copy destructively like overlay

Returns:

bool

true

Returns:

bool

true

Returns:

bool

true

Parameters:

nlines int number of window lines
ncols int number of window columns
begin_y int top line of window
begin_x int leftmost column of window

Returns:

window

Parameters:

ch int

Returns:

bool

true

Returns:

bool

true

Returns:

int y coordinate of top line
int x coordinate of left column
bool true, if successful

Returns:

int

Returns:

int

Returns:

int y coordinate of bottom line
int x coordinate of right column
bool true, if successful

Returns:

int y coordinate of top line relative to parent window
int x coordinate of left column relative to parent window

Parameters:

n int (optional)

Returns:

string

Returns:

int y coordinate of top line
int x coordinate of left column

Parameters:

ch int
n int

Returns:

bool

true

Usage:

  _, width = win:getmaxyx ()
  win:hline (curses.ACS_HLINE, width - curs_x)

curses.window:idcok (bf)

Use hardware character insert and delete on supporting terminals.

Parameters:

bf bool

Returns:

bool

true

Parameters:

bf bool

Returns:

bool

true

Parameters:

bf bool

Returns:

bool

true

Returns:

bool

true

Parameters:

bf bool

Returns:

bool

true

Parameters:

line int

Returns:

bool

true

Returns:

bool

true

Parameters:

on bool (optional)

Returns:

bool

true

Parameters:

bf bool

Returns:

bool

true

Parameters:

on bool true to force 8-bit input characters

Returns:

bool

true

Parameters:

y int
x int

Returns:

bool

true

Parameters:

par_y int lines from top of parent window
par_x int columns from left of parent window

Returns:

bool

true

Parameters:

y int offset frow top of screen
x int offset from left of screen

Returns:

bool

true

Parameters:

y int
x int
ch int

Returns:

bool

true

Parameters:

y int
x int
n int (optional)

Returns:

bool

true

Parameters:

y int
x int
str string
n int (optional)

Returns:

bool

true

Parameters:

y int
x int

Returns:

bool

true

Parameters:

y int
x int

Returns:

int

Parameters:

y int
x int
n int (default -1)

Returns:

string

Parameters:

y int
x int
ch int
n int

Returns:

bool

true

Parameters:

y int
x int
ch int
n int

Returns:

bool

true

Parameters:

y int
x int

Returns:

int

Parameters:

y int
x int
n int

Returns:

curses.chstr

Parameters:

y int
x int
n int

Returns:

string

Parameters:

y int
x int
ch int

Returns:

bool

true

Parameters:

y int
x int
str string
n int

Returns:

bool

true

Parameters:

y int
x int
str string

Returns:

bool

true

Parameters:

on bool

Returns:

bool

true

Parameters:

bf bool

Returns:

bool

true

curses.window:noutrefresh ()

Copy the window backing screen to the virtual screen.

Returns:

bool

true

Parameters:

dst window destination window

Returns:

bool

true

Parameters:

dst window destination window

Returns:

bool

true

Parameters:

ch int

Returns:

bool

true

Parameters:

st int top row from this pad window
sl int left column from this pad window
dt int top row of rectangle
dl int left column of rectangle
db int bottom row of rectangle
dr int right column of rectangle

Returns:

bool

true

Parameters:

st int top row from this pad window
sl int left column from this pad window
dt int top row of rectangle
dl int left column of rectangle
db int bottom row of rectangle
dr int right column of rectangle

Returns:

bool

true

Parameters:

beg_line int
num_lines int

Returns:

bool

true

Returns:

bool

true

Returns:

bool

true

Parameters:

height int new number of lines
width int new number of columns

Returns:

bool

true

curses.window:scrl (n)

Scroll the window up n lines.

Parameters:

n int

Returns:

bool

true

Parameters:

bf bool

Returns:

bool

true

Returns:

bool

true

Returns:

bool

true

Parameters:

nlines int number of window lines
ncols int number of window columns
begin_y int top line of window
begin_x int leftmost column of window

Returns:

window

Parameters:

nlines int
ncols int
begin_y int
begin_x int

Returns:

window

Parameters:

bf bool

Returns:

bool

true

curses.window:syncup ()

Mark ancestors of a window for refresh.

Parameters:

delay int milliseconds, 0 for blocking, -1 for non-blocking

Parameters:

changed (optional)

Returns:

bool

true

Parameters:

y int
n int
changed (optional)

Returns:

bool

true

Parameters:

ch int
n int

Returns:

bool

true

Parameters:

ch int

Returns:

bool

true

Parameters:

ch int

Returns:

int

Parameters:

n int

Returns:

curses.chstr

Parameters:

n int

Returns:

string

Parameters:

ch int

Returns:

bool

true

Parameters:

n int

Returns:

bool

true

Parameters:

str string
n int

Returns:

bool

true

Parameters:

str string

Returns:

bool

true

Parameters:

top int top line of the scrolling region (line 0 is the first line)
bot int bottom line of the scrolling region

Returns:

bool

true

Metamethods

curses.window:__tostring ()

Unique string representation of a curses.window.

Returns:

string

lcurses 9.0.0

Contents

Classes

Modules

Examples

Class curses.window

Methods

Metamethods

Methods

Parameters:

Returns:

See also:

Parameters:

Returns:

See also:

Parameters:

Returns:

See also:

Parameters:

Returns:

See also:

Parameters:

Returns:

See also:

Parameters:

Returns:

See also:

Parameters:

Returns:

See also:

Usage:

Parameters:

Returns:

See also:

Usage:

Returns:

See also:

Parameters:

Returns:

See also:

Returns:

See also:

See also:

Returns:

See also:

Returns:

See also:

Parameters:

Returns:

See also:

See also:

Returns:

See also:

Returns:

See also:

Parameters:

Returns:

See also:

Parameters:

Returns:

See also:

Returns:

See also:

Returns:

See also:

Returns:

See also:

Returns:

See also:

Returns:

See also:

Returns:

See also:

Parameters:

Returns:

See also:

Returns:

See also:

Parameters:

Returns:

Class `curses.window`