<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>luaposix 33.3.0 Reference</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>luaposix 33.3.0</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Methods">Methods</a></li>
<li><a href="#Metamethods">Metamethods</a></li>
</ul>
<h2>Classes</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../classes/posix.curses.chstr.html">posix.curses.chstr</a></li>
<li><strong>posix.curses.window</strong></li>
</ul>
<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../modules/posix.html">posix</a></li>
<li><a href="../modules/posix.ctype.html">posix.ctype</a></li>
<li><a href="../modules/posix.curses.html">posix.curses</a></li>
<li><a href="../modules/posix.dirent.html">posix.dirent</a></li>
<li><a href="../modules/posix.errno.html">posix.errno</a></li>
<li><a href="../modules/posix.fcntl.html">posix.fcntl</a></li>
<li><a href="../modules/posix.fnmatch.html">posix.fnmatch</a></li>
<li><a href="../modules/posix.getopt.html">posix.getopt</a></li>
<li><a href="../modules/posix.glob.html">posix.glob</a></li>
<li><a href="../modules/posix.grp.html">posix.grp</a></li>
<li><a href="../modules/posix.libgen.html">posix.libgen</a></li>
<li><a href="../modules/posix.poll.html">posix.poll</a></li>
<li><a href="../modules/posix.pwd.html">posix.pwd</a></li>
<li><a href="../modules/posix.sched.html">posix.sched</a></li>
<li><a href="../modules/posix.signal.html">posix.signal</a></li>
<li><a href="../modules/posix.stdio.html">posix.stdio</a></li>
<li><a href="../modules/posix.stdlib.html">posix.stdlib</a></li>
<li><a href="../modules/posix.sys.msg.html">posix.sys.msg</a></li>
<li><a href="../modules/posix.sys.resource.html">posix.sys.resource</a></li>
<li><a href="../modules/posix.sys.socket.html">posix.sys.socket</a></li>
<li><a href="../modules/posix.sys.stat.html">posix.sys.stat</a></li>
<li><a href="../modules/posix.sys.statvfs.html">posix.sys.statvfs</a></li>
<li><a href="../modules/posix.sys.time.html">posix.sys.time</a></li>
<li><a href="../modules/posix.sys.times.html">posix.sys.times</a></li>
<li><a href="../modules/posix.sys.utsname.html">posix.sys.utsname</a></li>
<li><a href="../modules/posix.sys.wait.html">posix.sys.wait</a></li>
<li><a href="../modules/posix.syslog.html">posix.syslog</a></li>
<li><a href="../modules/posix.termio.html">posix.termio</a></li>
<li><a href="../modules/posix.time.html">posix.time</a></li>
<li><a href="../modules/posix.unistd.html">posix.unistd</a></li>
<li><a href="../modules/posix.utime.html">posix.utime</a></li>
</ul>
<h2>Examples</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../examples/curses.lua.html">curses.lua</a></li>
<li><a href="../examples/dir.lua.html">dir.lua</a></li>
<li><a href="../examples/fork.lua.html">fork.lua</a></li>
<li><a href="../examples/fork2.lua.html">fork2.lua</a></li>
<li><a href="../examples/getopt.lua.html">getopt.lua</a></li>
<li><a href="../examples/glob.lua.html">glob.lua</a></li>
<li><a href="../examples/limit.lua.html">limit.lua</a></li>
<li><a href="../examples/lock.lua.html">lock.lua</a></li>
<li><a href="../examples/netlink-uevent.lua.html">netlink-uevent.lua</a></li>
<li><a href="../examples/ping.lua.html">ping.lua</a></li>
<li><a href="../examples/poll.lua.html">poll.lua</a></li>
<li><a href="../examples/rt_sched.lua.html">rt_sched.lua</a></li>
<li><a href="../examples/signal.lua.html">signal.lua</a></li>
<li><a href="../examples/socket.lua.html">socket.lua</a></li>
<li><a href="../examples/termios.lua.html">termios.lua</a></li>
<li><a href="../examples/tree.lua.html">tree.lua</a></li>
</ul>
</div>
<div id="content">
<h1>Class <code>posix.curses.window</code></h1>
<p>Curses Window objects.</p>
<p>
<p> The methods documented on this page are available on any Curses Window
object, such as created by:</p>
<pre>
stdscr = curses.initscr ()
window = curses.newwin (<span class="number">25</span>, <span class="number">80</span>, <span class="number">0</span>, <span class="number">0</span>)
</pre>
</p>
<h2><a href="#Methods">Methods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#posix.curses.window:addch">posix.curses.window:addch (ch)</a></td>
<td class="summary">Advance the cursor after writing a character at the old position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:addchstr">posix.curses.window:addchstr (chstr[, n])</a></td>
<td class="summary">Copy a <a href="../classes/posix.curses.chstr.html#">posix.curses.chstr</a> starting at the current cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:addstr">posix.curses.window:addstr (str[, n])</a></td>
<td class="summary">Copy a Lua string starting at the current cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:attroff">posix.curses.window:attroff (attrs)</a></td>
<td class="summary">Turn off the given attributes for subsequent writes to the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:attron">posix.curses.window:attron (attrs)</a></td>
<td class="summary">Turn on the given attributes for subsequent writes to the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:attrset">posix.curses.window:attrset (attrs)</a></td>
<td class="summary">Set the given attributes for subsequent writes to the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:border">posix.curses.window:border ([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])</a></td>
<td class="summary">Draw a border around a window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:box">posix.curses.window:box (verch, horch)</a></td>
<td class="summary">Draw a box around a window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:clear">posix.curses.window:clear ()</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:erase">erase</a> and then <a href="../classes/posix.curses.window.html#posix.curses.window:clearok">clearok</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:clearok">posix.curses.window:clearok (bf)</a></td>
<td class="summary">The next call to <a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a> will clear and completely redraw the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:clone">posix.curses.window:clone ()</a></td>
<td class="summary">Make a duplicate of a window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:close">posix.curses.window:close ()</a></td>
<td class="summary">Free all the resources associated with a window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:clrtobot">posix.curses.window:clrtobot ()</a></td>
<td class="summary">Write blanks to every character position after the cursor.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:clrtoeol">posix.curses.window:clrtoeol ()</a></td>
<td class="summary">Write blanks from the cursor to the end of the current line.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:copywin">posix.curses.window:copywin (dst, st, sl, dt, dl, db, dr, overlay)</a></td>
<td class="summary">Overlay a rectangle of this window over another.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:cursyncup">posix.curses.window:cursyncup ()</a></td>
<td class="summary">Mark cursor position of ancestors of a window for refresh.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:delch">posix.curses.window:delch ()</a></td>
<td class="summary">Delete the character under the cursor.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:deleteln">posix.curses.window:deleteln ()</a></td>
<td class="summary">Move the lines below the cursor up, to delete the current line.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:derive">posix.curses.window:derive (nlines, ncols, begin_y, begin_x)</a></td>
<td class="summary">Create a new derived window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:echoch">posix.curses.window:echoch (ch)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:addch">addch</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:erase">posix.curses.window:erase ()</a></td>
<td class="summary">Write blanks to every character position in the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:getbegyx">posix.curses.window:getbegyx ()</a></td>
<td class="summary">Fetch the absolute top-left coordinates of a window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:getbkgd">posix.curses.window:getbkgd ()</a></td>
<td class="summary">Fetch the current background attribute for the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:getch">posix.curses.window:getch ()</a></td>
<td class="summary">Read a character from the window input.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:getmaxyx">posix.curses.window:getmaxyx ()</a></td>
<td class="summary">Fetch the absolute bottom-right coordinates of a window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:getparyx">posix.curses.window:getparyx ()</a></td>
<td class="summary">Fetch the parent-relative coordinates of a subwindow.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:getstr">posix.curses.window:getstr ([n])</a></td>
<td class="summary">Read characters up to the next newline from the window input.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:getyx">posix.curses.window:getyx ()</a></td>
<td class="summary">Fetch the cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:hline">posix.curses.window:hline (ch, n)</a></td>
<td class="summary">Draw a row of characters from the current cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:idcok">posix.curses.window:idcok (bf)</a></td>
<td class="summary">Use hardware character insert and delete on supporting terminals.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:idlok">posix.curses.window:idlok (bf)</a></td>
<td class="summary">Use hardware line insert and delete on supporting terminals.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:immedok">posix.curses.window:immedok (bf)</a></td>
<td class="summary">Automatically call <a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a> whenever the window content is changed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:insertln">posix.curses.window:insertln ()</a></td>
<td class="summary">Move the current line and those below down one line, leaving a new blank line.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:intrflush">posix.curses.window:intrflush (bf)</a></td>
<td class="summary">Set the flush on interrupt behaviour for the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:is_linetouched">posix.curses.window:is_linetouched (line)</a></td>
<td class="summary">Has a particular window line changed since the last refresh?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:is_wintouched">posix.curses.window:is_wintouched ()</a></td>
<td class="summary">Has a window changed since the last refresh?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:keypad">posix.curses.window:keypad ([on])</a></td>
<td class="summary">Set the single value keypad keys behaviour for the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:leaveok">posix.curses.window:leaveok (bf)</a></td>
<td class="summary">No need to force synchronisation of hardware cursor.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:meta">posix.curses.window:meta (on)</a></td>
<td class="summary">Force 8-bit (or 7-bit) input characters for the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:move">posix.curses.window:move (y, x)</a></td>
<td class="summary">Change the cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:move_derived">posix.curses.window:move_derived (par_y, par_x)</a></td>
<td class="summary">Move the position of a derived window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:move_window">posix.curses.window:move_window (y, x)</a></td>
<td class="summary">Move the position of a window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvaddch">posix.curses.window:mvaddch (ch)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a>, then <a href="../classes/posix.curses.window.html#posix.curses.window:addch">addch</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvaddchstr">posix.curses.window:mvaddchstr (y, x[, n])</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:addchstr">addchstr</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvaddstr">posix.curses.window:mvaddstr (y, x, str[, n])</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:addstr">addstr</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvdelch">posix.curses.window:mvdelch (y, x)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:delch">delch</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvgetch">posix.curses.window:mvgetch (y, x)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:getch">getch</a></td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvgetstr">posix.curses.window:mvgetstr (y, x[, n=-1])</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:getstr">getstr</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvhline">posix.curses.window:mvhline (y, x, ch, n)</a></td>
<td class="summary">Move the cursor, then draw a row of characters from the new cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvvline">posix.curses.window:mvvline (y, x, ch, n)</a></td>
<td class="summary">Move the cursor, then draw a column of characters from the new cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvwinch">posix.curses.window:mvwinch (y, x)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winch">winch</a></td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvwinchnstr">posix.curses.window:mvwinchnstr (y, x, n)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winchnstr">winchnstr</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvwinnstr">posix.curses.window:mvwinnstr (y, x, n)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winnstr">winnstr</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvwinsch">posix.curses.window:mvwinsch (y, x, ch)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winsch">winsch</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvwinsnstr">posix.curses.window:mvwinsnstr (y, x, str, n)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winsnstr">winsnstr</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:mvwinsstr">posix.curses.window:mvwinsstr (y, x, str)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winsstr">winsstr</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:nodelay">posix.curses.window:nodelay (on)</a></td>
<td class="summary">Force <a href="../classes/posix.curses.window.html#posix.curses.window:getch">getch</a> to be non-blocking.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:notimeout">posix.curses.window:notimeout (bf)</a></td>
<td class="summary">Return input immediately from this window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:noutrefresh">posix.curses.window:noutrefresh ()</a></td>
<td class="summary">Copy the window backing screen to the virtual screen.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:overlay">posix.curses.window:overlay (dst)</a></td>
<td class="summary">Overlay this window on top of another non-destructively.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:overwrite">posix.curses.window:overwrite (dst)</a></td>
<td class="summary">Destructively overwrite another window with this one.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:pechochar">posix.curses.window:pechochar (ch)</a></td>
<td class="summary">An efficient equivalent to <a href="../classes/posix.curses.window.html#posix.curses.window:addch">addch</a> followed by <a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:pnoutrefresh">posix.curses.window:pnoutrefresh (st, sl, dt, dl, db, dr)</a></td>
<td class="summary">Equivalent to <a href="../classes/posix.curses.window.html#posix.curses.window:noutrefresh">noutrefresh</a> for use with pad windows.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:prefresh">posix.curses.window:prefresh (st, sl, dt, dl, db, dr)</a></td>
<td class="summary">Equivalent to <a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a> for use with pad windows.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:redrawln">posix.curses.window:redrawln (beg_line, num_lines)</a></td>
<td class="summary">Mark a range of lines in a window as corrupted and in need of redrawing.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:redrawwin">posix.curses.window:redrawwin ()</a></td>
<td class="summary">Mark a window as having corrupted display that needs fully redrawing.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:refresh">posix.curses.window:refresh ()</a></td>
<td class="summary">Refresh the window terminal display from the virtual screen.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:resize">posix.curses.window:resize (height, width)</a></td>
<td class="summary">Change the size of a window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:scrl">posix.curses.window:scrl (n)</a></td>
<td class="summary">Scroll the window up <em>n</em> lines.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:scrollok">posix.curses.window:scrollok (bf)</a></td>
<td class="summary">Scroll up one line when the cursor writes to the last screen position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:standend">posix.curses.window:standend ()</a></td>
<td class="summary">Turn off all attributes for subsequent writes to the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:standout">posix.curses.window:standout ()</a></td>
<td class="summary">Set <code>A_STANDOUT</code> for subsequent writes to the window.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:sub">posix.curses.window:sub (nlines, ncols, begin_y, begin_x)</a></td>
<td class="summary">Create a new subwindow.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:subpad">posix.curses.window:subpad (nlines, ncols, begin_y, begin_x)</a></td>
<td class="summary">Return a new subpad window object.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:syncdown">posix.curses.window:syncdown ()</a></td>
<td class="summary">Mark child windows for refresh.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:syncok">posix.curses.window:syncok (bf)</a></td>
<td class="summary">Automatically mark ancestors of a changed window for refresh.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:syncup">posix.curses.window:syncup ()</a></td>
<td class="summary">Mark ancestors of a window for refresh.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:timeout">posix.curses.window:timeout (delay)</a></td>
<td class="summary">For differentiating user input from terminal control sequences.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:touch">posix.curses.window:touch ([changed])</a></td>
<td class="summary">Set the changed state of a window since the last refresh.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:touchline">posix.curses.window:touchline (y, n[, changed])</a></td>
<td class="summary">Mark a range of lines as changed since the last refresh.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:vline">posix.curses.window:vline (ch, n)</a></td>
<td class="summary">Draw a column of characters from the current cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:wbkgd">posix.curses.window:wbkgd (ch)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:wbkgdset">wbkgdset</a> and then set the background of every position accordingly.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:wbkgdset">posix.curses.window:wbkgdset (ch)</a></td>
<td class="summary">Set the background attributes for subsequently written characters.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:winch">posix.curses.window:winch ()</a></td>
<td class="summary">Fetch the attributed character at the current cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:winchnstr">posix.curses.window:winchnstr (n)</a></td>
<td class="summary">Fetch attributed characters from cursor position up to rightmost window position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:winnstr">posix.curses.window:winnstr (n)</a></td>
<td class="summary">Fetch a string from cursor position up to rightmost window position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:winsch">posix.curses.window:winsch (ch)</a></td>
<td class="summary">Insert a character before the current cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:winsdelln">posix.curses.window:winsdelln (n)</a></td>
<td class="summary">Call <a href="../classes/posix.curses.window.html#posix.curses.window:deleteln">deleteln</a> <em>n</em> times.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:winsnstr">posix.curses.window:winsnstr (str, n)</a></td>
<td class="summary">Like <a href="../classes/posix.curses.window.html#posix.curses.window:winsstr">winsstr</a>, but no more than <em>n</em> characters.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:winsstr">posix.curses.window:winsstr (str)</a></td>
<td class="summary">Insert a string of characters before the current cursor position.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#posix.curses.window:wsetscrreg">posix.curses.window:wsetscrreg (top, bot)</a></td>
<td class="summary">Set a software scrolling region for the window.</td>
</tr>
</table>
<h2><a href="#Metamethods">Metamethods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#posix.curses.window:__tostring">posix.curses.window:__tostring ()</a></td>
<td class="summary">Unique string representation of a <a href="../classes/posix.curses.window.html#">posix.curses.window</a>.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Methods"></a>Methods</h2>
<dl class="function">
<dt>
<a name = "posix.curses.window:addch"></a>
<strong>posix.curses.window:addch (ch)</strong>
</dt>
<dd>
Advance the cursor after writing a character at the old position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_addch.html">curs_addch(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:addchstr"></a>
<strong>posix.curses.window:addchstr (chstr[, n])</strong>
</dt>
<dd>
Copy a <a href="../classes/posix.curses.chstr.html#">posix.curses.chstr</a> starting at the current cursor position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">chstr</span>
<span class="types"><span class="type">int</span></span>
cs
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_addchstr.html">curs_addchstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:addstr"></a>
<strong>posix.curses.window:addstr (str[, n])</strong>
</dt>
<dd>
Copy a Lua string starting at the current cursor position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">str</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_addstr.html">curs_addstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:attroff"></a>
<strong>posix.curses.window:attroff (attrs)</strong>
</dt>
<dd>
Turn off the given attributes for subsequent writes to the window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">attrs</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_attr.html">curs_attr(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:standend">standend</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:attron"></a>
<strong>posix.curses.window:attron (attrs)</strong>
</dt>
<dd>
Turn on the given attributes for subsequent writes to the window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">attrs</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_attr.html">curs_attr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:attrset"></a>
<strong>posix.curses.window:attrset (attrs)</strong>
</dt>
<dd>
Set the given attributes for subsequent writes to the window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">attrs</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_attr.html">curs_attr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:border"></a>
<strong>posix.curses.window:border ([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])</strong>
</dt>
<dd>
Draw a border around a window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">ls</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
<li><span class="parameter">rs</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
<li><span class="parameter">ts</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
<li><span class="parameter">bs</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
<li><span class="parameter">tl</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
<li><span class="parameter">tr</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
<li><span class="parameter">bl</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
<li><span class="parameter">br</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_border.html">curs_border(3x)</a>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">
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)</pre>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:box"></a>
<strong>posix.curses.window:box (verch, horch)</strong>
</dt>
<dd>
Draw a box around a window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">verch</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">horch</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_border.html">curs_border(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:border">border</a></li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">win:box (curses.ACS_VLINE, curses.ACS_HLINE)</pre>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:clear"></a>
<strong>posix.curses.window:clear ()</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:erase">erase</a> and then <a href="../classes/posix.curses.window.html#posix.curses.window:clearok">clearok</a>.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_border.html">curs_border(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:clearok"></a>
<strong>posix.curses.window:clearok (bf)</strong>
</dt>
<dd>
The next call to <a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a> will clear and completely redraw the window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bf</span>
<span class="types"><span class="type">bool</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_outopts.html">curs_outopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:clone"></a>
<strong>posix.curses.window:clone ()</strong>
</dt>
<dd>
Make a duplicate of a window.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/posix.curses.window.html">window</a></span>
a new duplicate of this window
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_window.html">curs_window(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:close"></a>
<strong>posix.curses.window:close ()</strong>
</dt>
<dd>
Free all the resources associated with a window.
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_window.html">curs_window(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:clrtobot"></a>
<strong>posix.curses.window:clrtobot ()</strong>
</dt>
<dd>
Write blanks to every character position after the cursor.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_border.html">curs_border(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:clrtoeol"></a>
<strong>posix.curses.window:clrtoeol ()</strong>
</dt>
<dd>
Write blanks from the cursor to the end of the current line.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_border.html">curs_border(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:copywin"></a>
<strong>posix.curses.window:copywin (dst, st, sl, dt, dl, db, dr, overlay)</strong>
</dt>
<dd>
Overlay a rectangle of this window over another.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">dst</span>
<span class="types"><a class="type" href="../classes/posix.curses.window.html">window</a></span>
destination window
</li>
<li><span class="parameter">st</span>
<span class="types"><span class="type">int</span></span>
top row from this window
</li>
<li><span class="parameter">sl</span>
<span class="types"><span class="type">int</span></span>
left column from this window
</li>
<li><span class="parameter">dt</span>
<span class="types"><span class="type">int</span></span>
top row of rectangle
</li>
<li><span class="parameter">dl</span>
<span class="types"><span class="type">int</span></span>
left column of rectangle
</li>
<li><span class="parameter">db</span>
<span class="types"><span class="type">int</span></span>
bottom row of rectangle
</li>
<li><span class="parameter">dr</span>
<span class="types"><span class="type">int</span></span>
right column of rectangle
</li>
<li><span class="parameter">overlay</span>
<span class="types"><span class="type">bool</span></span>
if <code>true</code>, copy destructively like <a href="../classes/posix.curses.window.html#posix.curses.window:overlay">overlay</a>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_inopts.html">curs_inopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:cursyncup"></a>
<strong>posix.curses.window:cursyncup ()</strong>
</dt>
<dd>
Mark cursor position of ancestors of a window for refresh.
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_window.html">curs_window(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:delch"></a>
<strong>posix.curses.window:delch ()</strong>
</dt>
<dd>
Delete the character under the cursor.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_delch.html">curs_delch(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:deleteln"></a>
<strong>posix.curses.window:deleteln ()</strong>
</dt>
<dd>
Move the lines below the cursor up, to delete the current line.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_deleteln.html">curs_deleteln(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:derive"></a>
<strong>posix.curses.window:derive (nlines, ncols, begin_y, begin_x)</strong>
</dt>
<dd>
Create a new derived window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">nlines</span>
<span class="types"><span class="type">int</span></span>
number of window lines
</li>
<li><span class="parameter">ncols</span>
<span class="types"><span class="type">int</span></span>
number of window columns
</li>
<li><span class="parameter">begin_y</span>
<span class="types"><span class="type">int</span></span>
top line of window
</li>
<li><span class="parameter">begin_x</span>
<span class="types"><span class="type">int</span></span>
leftmost column of window
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/posix.curses.window.html">window</a></span>
a new relatively positioned subwindow
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_window.html">curs_window(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:sub">sub</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:echoch"></a>
<strong>posix.curses.window:echoch (ch)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:addch">addch</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_addch.html">curs_addch(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:erase"></a>
<strong>posix.curses.window:erase ()</strong>
</dt>
<dd>
Write blanks to every character position in the window.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_clear.html">curs_clear(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:getbegyx"></a>
<strong>posix.curses.window:getbegyx ()</strong>
</dt>
<dd>
Fetch the absolute top-left coordinates of a window.
<h3>Returns:</h3>
<ol>
<li>
<span class="types"><span class="type">int</span></span>
y coordinate of top line</li>
<li>
<span class="types"><span class="type">int</span></span>
x coordinate of left column</li>
<li>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful</li>
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getyx.html">curs_getyx(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:getbkgd"></a>
<strong>posix.curses.window:getbkgd ()</strong>
</dt>
<dd>
Fetch the current background attribute for the window.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
current window background attribute
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_bkgd.html">curs_bkgd(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:wbkgd">wbkgd</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:getch"></a>
<strong>posix.curses.window:getch ()</strong>
</dt>
<dd>
Read a character from the window input.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getch.html">curs_getch(3x)</a></li>
<li><a href="../modules/posix.curses.html#cbreak">posix.curses.cbreak</a></li>
<li><a href="../modules/posix.curses.html#echo">posix.curses.echo</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:keypad">keypad</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:getmaxyx"></a>
<strong>posix.curses.window:getmaxyx ()</strong>
</dt>
<dd>
Fetch the absolute bottom-right coordinates of a window.
<h3>Returns:</h3>
<ol>
<li>
<span class="types"><span class="type">int</span></span>
y coordinate of bottom line</li>
<li>
<span class="types"><span class="type">int</span></span>
x coordinate of right column</li>
<li>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful</li>
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getyx.html">curs_getyx(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:getparyx"></a>
<strong>posix.curses.window:getparyx ()</strong>
</dt>
<dd>
Fetch the parent-relative coordinates of a subwindow.
<h3>Returns:</h3>
<ol>
<li>
<span class="types"><span class="type">int</span></span>
y coordinate of top line relative to parent window</li>
<li>
<span class="types"><span class="type">int</span></span>
x coordinate of left column relative to parent window</li>
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getyx.html">curs_getyx(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:getstr"></a>
<strong>posix.curses.window:getstr ([n])</strong>
</dt>
<dd>
Read characters up to the next newline from the window input.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getstr.html">curs_getstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:getyx"></a>
<strong>posix.curses.window:getyx ()</strong>
</dt>
<dd>
Fetch the cursor position.
<h3>Returns:</h3>
<ol>
<li>
<span class="types"><span class="type">int</span></span>
y coordinate of top line</li>
<li>
<span class="types"><span class="type">int</span></span>
x coordinate of left column</li>
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getyx.html">curs_getyx(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:hline"></a>
<strong>posix.curses.window:hline (ch, n)</strong>
</dt>
<dd>
Draw a row of characters from the current cursor position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_border.html">curs_border(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:mvhline">mvhline</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:vline">vline</a></li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">
_, width = win:getmaxyx ()
win:hline (curses.ACS_HLINE, width - curs_x)</pre>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:idcok"></a>
<strong>posix.curses.window:idcok (bf)</strong>
</dt>
<dd>
Use hardware character insert and delete on supporting terminals.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bf</span>
<span class="types"><span class="type">bool</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_outopts.html">curs_outopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:idlok"></a>
<strong>posix.curses.window:idlok (bf)</strong>
</dt>
<dd>
Use hardware line insert and delete on supporting terminals.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bf</span>
<span class="types"><span class="type">bool</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_outopts.html">curs_outopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:immedok"></a>
<strong>posix.curses.window:immedok (bf)</strong>
</dt>
<dd>
Automatically call <a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a> whenever the window content is changed.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bf</span>
<span class="types"><span class="type">bool</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_outopts.html">curs_outopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:insertln"></a>
<strong>posix.curses.window:insertln ()</strong>
</dt>
<dd>
Move the current line and those below down one line, leaving a new blank line.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_deleteln.html">curs_deleteln(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:intrflush"></a>
<strong>posix.curses.window:intrflush (bf)</strong>
</dt>
<dd>
Set the flush on interrupt behaviour for the window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bf</span>
<span class="types"><span class="type">bool</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_inopts.html">curs_inopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:is_linetouched"></a>
<strong>posix.curses.window:is_linetouched (line)</strong>
</dt>
<dd>
Has a particular window line changed since the last refresh?
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">line</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_refresh.html">curs_refresh(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:is_wintouched"></a>
<strong>posix.curses.window:is_wintouched ()</strong>
</dt>
<dd>
Has a window changed since the last refresh?
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_refresh.html">curs_refresh(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:keypad"></a>
<strong>posix.curses.window:keypad ([on])</strong>
</dt>
<dd>
Set the single value keypad keys behaviour for the window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">on</span>
<span class="types"><span class="type">bool</span></span>
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_inopts.html">curs_inopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:leaveok"></a>
<strong>posix.curses.window:leaveok (bf)</strong>
</dt>
<dd>
No need to force synchronisation of hardware cursor.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bf</span>
<span class="types"><span class="type">bool</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_outopts.html">curs_outopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:meta"></a>
<strong>posix.curses.window:meta (on)</strong>
</dt>
<dd>
Force 8-bit (or 7-bit) input characters for the window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">on</span>
<span class="types"><span class="type">bool</span></span>
<code>true</code> to force 8-bit input characters
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_inopts.html">curs_inopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:move"></a>
<strong>posix.curses.window:move (y, x)</strong>
</dt>
<dd>
Change the cursor position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_move.html">curs_move(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:move_derived"></a>
<strong>posix.curses.window:move_derived (par_y, par_x)</strong>
</dt>
<dd>
Move the position of a derived window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">par_y</span>
<span class="types"><span class="type">int</span></span>
lines from top of parent window
</li>
<li><span class="parameter">par_x</span>
<span class="types"><span class="type">int</span></span>
columns from left of parent window
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_window.html">curs_window(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:move_window"></a>
<strong>posix.curses.window:move_window (y, x)</strong>
</dt>
<dd>
Move the position of a window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
offset frow top of screen
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
offset from left of screen
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_window.html">curs_window(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvaddch"></a>
<strong>posix.curses.window:mvaddch (ch)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a>, then <a href="../classes/posix.curses.window.html#posix.curses.window:addch">addch</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_addch.html">curs_addch(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvaddchstr"></a>
<strong>posix.curses.window:mvaddchstr (y, x[, n])</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:addchstr">addchstr</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_addchstr.html">curs_addchstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvaddstr"></a>
<strong>posix.curses.window:mvaddstr (y, x, str[, n])</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:addstr">addstr</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">str</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_addstr.html">curs_addstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvdelch"></a>
<strong>posix.curses.window:mvdelch (y, x)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:delch">delch</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_util.html">curs_util(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvgetch"></a>
<strong>posix.curses.window:mvgetch (y, x)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:getch">getch</a>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_deleteln.html">curs_deleteln(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvgetstr"></a>
<strong>posix.curses.window:mvgetstr (y, x[, n=-1])</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:getstr">getstr</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
(<em>default</em> -1)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getstr.html">curs_getstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvhline"></a>
<strong>posix.curses.window:mvhline (y, x, ch, n)</strong>
</dt>
<dd>
Move the cursor, then draw a row of characters from the new cursor position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_border.html">curs_border(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvvline"></a>
<strong>posix.curses.window:mvvline (y, x, ch, n)</strong>
</dt>
<dd>
Move the cursor, then draw a column of characters from the new cursor position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_border.html">curs_border(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvwinch"></a>
<strong>posix.curses.window:mvwinch (y, x)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winch">winch</a>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getstr.html">curs_getstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvwinchnstr"></a>
<strong>posix.curses.window:mvwinchnstr (y, x, n)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winchnstr">winchnstr</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getstr.html">curs_getstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvwinnstr"></a>
<strong>posix.curses.window:mvwinnstr (y, x, n)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winnstr">winnstr</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_instr.html">curs_instr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvwinsch"></a>
<strong>posix.curses.window:mvwinsch (y, x, ch)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winsch">winsch</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_insch.html">curs_insch(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvwinsnstr"></a>
<strong>posix.curses.window:mvwinsnstr (y, x, str, n)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winsnstr">winsnstr</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">str</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getstr.html">curs_getstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:mvwinsstr"></a>
<strong>posix.curses.window:mvwinsstr (y, x, str)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:move">move</a> then <a href="../classes/posix.curses.window.html#posix.curses.window:winsstr">winsstr</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">x</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">str</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getstr.html">curs_getstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:nodelay"></a>
<strong>posix.curses.window:nodelay (on)</strong>
</dt>
<dd>
Force <a href="../classes/posix.curses.window.html#posix.curses.window:getch">getch</a> to be non-blocking.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">on</span>
<span class="types"><span class="type">bool</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_inopts.html">curs_inopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:notimeout"></a>
<strong>posix.curses.window:notimeout (bf)</strong>
</dt>
<dd>
Return input immediately from this window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bf</span>
<span class="types"><span class="type">bool</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_inopts.html">curs_inopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:noutrefresh"></a>
<strong>posix.curses.window:noutrefresh ()</strong>
</dt>
<dd>
Copy the window backing screen to the virtual screen.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_refresh.html">curs_refresh(3x)</a></li>
<li><a href="../modules/posix.curses.html#doupdate">posix.curses.doupdate</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:overlay"></a>
<strong>posix.curses.window:overlay (dst)</strong>
</dt>
<dd>
Overlay this window on top of another non-destructively.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">dst</span>
<span class="types"><a class="type" href="../classes/posix.curses.window.html">window</a></span>
destination window
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_overlay.html">curs_overlay(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:overwrite">overwrite</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:overwrite"></a>
<strong>posix.curses.window:overwrite (dst)</strong>
</dt>
<dd>
Destructively overwrite another window with this one.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">dst</span>
<span class="types"><a class="type" href="../classes/posix.curses.window.html">window</a></span>
destination window
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_inopts.html">curs_inopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:pechochar"></a>
<strong>posix.curses.window:pechochar (ch)</strong>
</dt>
<dd>
An efficient equivalent to <a href="../classes/posix.curses.window.html#posix.curses.window:addch">addch</a> followed by <a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a>.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/cur_pad.html">cur_pad(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:pnoutrefresh"></a>
<strong>posix.curses.window:pnoutrefresh (st, sl, dt, dl, db, dr)</strong>
</dt>
<dd>
Equivalent to <a href="../classes/posix.curses.window.html#posix.curses.window:noutrefresh">noutrefresh</a> for use with pad windows.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">st</span>
<span class="types"><span class="type">int</span></span>
top row from this pad window
</li>
<li><span class="parameter">sl</span>
<span class="types"><span class="type">int</span></span>
left column from this pad window
</li>
<li><span class="parameter">dt</span>
<span class="types"><span class="type">int</span></span>
top row of rectangle
</li>
<li><span class="parameter">dl</span>
<span class="types"><span class="type">int</span></span>
left column of rectangle
</li>
<li><span class="parameter">db</span>
<span class="types"><span class="type">int</span></span>
bottom row of rectangle
</li>
<li><span class="parameter">dr</span>
<span class="types"><span class="type">int</span></span>
right column of rectangle
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/cur_pad.html">cur_pad(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:prefresh"></a>
<strong>posix.curses.window:prefresh (st, sl, dt, dl, db, dr)</strong>
</dt>
<dd>
Equivalent to <a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a> for use with pad windows.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">st</span>
<span class="types"><span class="type">int</span></span>
top row from this pad window
</li>
<li><span class="parameter">sl</span>
<span class="types"><span class="type">int</span></span>
left column from this pad window
</li>
<li><span class="parameter">dt</span>
<span class="types"><span class="type">int</span></span>
top row of rectangle
</li>
<li><span class="parameter">dl</span>
<span class="types"><span class="type">int</span></span>
left column of rectangle
</li>
<li><span class="parameter">db</span>
<span class="types"><span class="type">int</span></span>
bottom row of rectangle
</li>
<li><span class="parameter">dr</span>
<span class="types"><span class="type">int</span></span>
right column of rectangle
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/cur_pad.html">cur_pad(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:redrawln"></a>
<strong>posix.curses.window:redrawln (beg_line, num_lines)</strong>
</dt>
<dd>
Mark a range of lines in a window as corrupted and in need of redrawing.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">beg_line</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">num_lines</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_refresh.html">curs_refresh(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:redrawwin"></a>
<strong>posix.curses.window:redrawwin ()</strong>
</dt>
<dd>
Mark a window as having corrupted display that needs fully redrawing.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_refresh.html">curs_refresh(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:redrawln">redrawln</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:refresh"></a>
<strong>posix.curses.window:refresh ()</strong>
</dt>
<dd>
Refresh the window terminal display from the virtual screen.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_refresh.html">curs_refresh(3x)</a></li>
<li><a href="../modules/posix.curses.html#doupdate">posix.curses.doupdate</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:noutrefresh">noutrefresh</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:resize"></a>
<strong>posix.curses.window:resize (height, width)</strong>
</dt>
<dd>
Change the size of a window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">height</span>
<span class="types"><span class="type">int</span></span>
new number of lines
</li>
<li><span class="parameter">width</span>
<span class="types"><span class="type">int</span></span>
new number of columns
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_wresize.html">curs_wresize(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:scrl"></a>
<strong>posix.curses.window:scrl (n)</strong>
</dt>
<dd>
Scroll the window up <em>n</em> lines.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_scroll.html">curs_scroll(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:scrollok"></a>
<strong>posix.curses.window:scrollok (bf)</strong>
</dt>
<dd>
Scroll up one line when the cursor writes to the last screen position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bf</span>
<span class="types"><span class="type">bool</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_outopts.html">curs_outopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:standend"></a>
<strong>posix.curses.window:standend ()</strong>
</dt>
<dd>
Turn off all attributes for subsequent writes to the window.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_attr.html">curs_attr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:standout"></a>
<strong>posix.curses.window:standout ()</strong>
</dt>
<dd>
Set <code>A_STANDOUT</code> for subsequent writes to the window.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_attr.html">curs_attr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:sub"></a>
<strong>posix.curses.window:sub (nlines, ncols, begin_y, begin_x)</strong>
</dt>
<dd>
Create a new subwindow.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">nlines</span>
<span class="types"><span class="type">int</span></span>
number of window lines
</li>
<li><span class="parameter">ncols</span>
<span class="types"><span class="type">int</span></span>
number of window columns
</li>
<li><span class="parameter">begin_y</span>
<span class="types"><span class="type">int</span></span>
top line of window
</li>
<li><span class="parameter">begin_x</span>
<span class="types"><span class="type">int</span></span>
leftmost column of window
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/posix.curses.window.html">window</a></span>
a new absolutely positioned subwindow
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_window.html">curs_window(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:derive">derive</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:subpad"></a>
<strong>posix.curses.window:subpad (nlines, ncols, begin_y, begin_x)</strong>
</dt>
<dd>
Return a new subpad window object.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">nlines</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">ncols</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">begin_y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">begin_x</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/posix.curses.window.html">window</a></span>
a new subpad window object
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/cur_pad.html">cur_pad(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:syncdown"></a>
<strong>posix.curses.window:syncdown ()</strong>
</dt>
<dd>
Mark child windows for refresh.
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_window.html">curs_window(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:refresh">refresh</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:syncok"></a>
<strong>posix.curses.window:syncok (bf)</strong>
</dt>
<dd>
Automatically mark ancestors of a changed window for refresh.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bf</span>
<span class="types"><span class="type">bool</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_window.html">curs_window(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:syncup"></a>
<strong>posix.curses.window:syncup ()</strong>
</dt>
<dd>
Mark ancestors of a window for refresh.
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_window.html">curs_window(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:timeout"></a>
<strong>posix.curses.window:timeout (delay)</strong>
</dt>
<dd>
For differentiating user input from terminal control sequences.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">delay</span>
<span class="types"><span class="type">int</span></span>
milliseconds, <code>0</code> for blocking, <code>-1</code> for non-blocking
</li>
</ul>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_inopts.html">curs_inopts(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:touch"></a>
<strong>posix.curses.window:touch ([changed])</strong>
</dt>
<dd>
Set the changed state of a window since the last refresh.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">changed</span>
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_touch.html">curs_touch(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:touchline"></a>
<strong>posix.curses.window:touchline (y, n[, changed])</strong>
</dt>
<dd>
Mark a range of lines as changed since the last refresh.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">y</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">changed</span>
(<em>optional</em>)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_refresh.html">curs_refresh(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:vline"></a>
<strong>posix.curses.window:vline (ch, n)</strong>
</dt>
<dd>
Draw a column of characters from the current cursor position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_border.html">curs_border(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:hline">hline</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:mvvline">mvvline</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:wbkgd"></a>
<strong>posix.curses.window:wbkgd (ch)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:wbkgdset">wbkgdset</a> and then set the background of every position accordingly.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_bkgd.html">curs_bkgd(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:wbkgdset"></a>
<strong>posix.curses.window:wbkgdset (ch)</strong>
</dt>
<dd>
Set the background attributes for subsequently written characters.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_bkgd.html">curs_bkgd(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:winch"></a>
<strong>posix.curses.window:winch ()</strong>
</dt>
<dd>
Fetch the attributed character at the current cursor position.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_inch.html">curs_inch(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:winchnstr"></a>
<strong>posix.curses.window:winchnstr (n)</strong>
</dt>
<dd>
Fetch attributed characters from cursor position up to rightmost window position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/posix.curses.chstr.html#">posix.curses.chstr</a></span>
characters from cursor to end of line
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_inchstr.html">curs_inchstr(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:winnstr">winnstr</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:winnstr"></a>
<strong>posix.curses.window:winnstr (n)</strong>
</dt>
<dd>
Fetch a string from cursor position up to rightmost window position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_instr.html">curs_instr(3x)</a></li>
<li><a href="../classes/posix.curses.window.html#posix.curses.window:winchnstr">winchnstr</a></li>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:winsch"></a>
<strong>posix.curses.window:winsch (ch)</strong>
</dt>
<dd>
Insert a character before the current cursor position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">ch</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_insch.html">curs_insch(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:winsdelln"></a>
<strong>posix.curses.window:winsdelln (n)</strong>
</dt>
<dd>
Call <a href="../classes/posix.curses.window.html#posix.curses.window:deleteln">deleteln</a> <em>n</em> times.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_deleteln.html">curs_deleteln(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:winsnstr"></a>
<strong>posix.curses.window:winsnstr (str, n)</strong>
</dt>
<dd>
Like <a href="../classes/posix.curses.window.html#posix.curses.window:winsstr">winsstr</a>, but no more than <em>n</em> characters.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">str</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
</li>
<li><span class="parameter">n</span>
<span class="types"><span class="type">int</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_getstr.html">curs_getstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:winsstr"></a>
<strong>posix.curses.window:winsstr (str)</strong>
</dt>
<dd>
Insert a string of characters before the current cursor position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">str</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_insstr.html">curs_insstr(3x)</a>
</ul>
</dd>
<dt>
<a name = "posix.curses.window:wsetscrreg"></a>
<strong>posix.curses.window:wsetscrreg (top, bot)</strong>
</dt>
<dd>
Set a software scrolling region for the window.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">top</span>
<span class="types"><span class="type">int</span></span>
top line of the scrolling region (line 0 is the first line)
</li>
<li><span class="parameter">bot</span>
<span class="types"><span class="type">int</span></span>
bottom line of the scrolling region
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
<code>true</code>, if successful
</ol>
<h3>See also:</h3>
<ul>
<a href="http://pubs.opengroup.org/onlinepubs/009695399/functions/curs_outopts.html">curs_outopts(3x)</a>
</ul>
</dd>
</dl>
<h2><a name="Metamethods"></a>Metamethods</h2>
<dl class="function">
<dt>
<a name = "posix.curses.window:__tostring"></a>
<strong>posix.curses.window:__tostring ()</strong>
</dt>
<dd>
Unique string representation of a <a href="../classes/posix.curses.window.html#">posix.curses.window</a>.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
unique string representation of the window object.
</ol>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2015-03-01 09:06:02 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>