Class: Curses::Window
- Inherits:
-
Data
- Object
- Data
- Curses::Window
- Defined in:
- curses.c
Overview
Description
The means by which to create and manage frames or windows. While there may be more than one window at a time, only one window will receive input.
Usage
require 'curses'
Curses.init_screen()
my_str = "LOOK! PONIES!"
win = Curses::Window.new( 8, (my_str.length + 10),
(Curses.lines - 8) / 2,
(Curses.cols - (my_str.length + 10)) / 2 )
win.box("|", "-")
win.setpos(2,3)
win.addstr(my_str)
# or even
win << "\nORLY"
win << "\nYES!! " + my_str
win.refresh
win.getch
win.close
Instance Method Summary collapse
-
#<< ⇒ Object
call-seq: <<(str).
-
#addch(ch) ⇒ Object
Add a character
ch
, with attributes, to the window, then advance the cursor. -
#addstr(str) ⇒ Object
add a string of characters
str
, to the window and advance cursor. -
#attroff(attrs) ⇒ Object
Turns on the named attributes
attrs
without affecting any others. -
#attron(attrs) ⇒ Object
Turns off the named attributes
attrs
without turning any other attributes on or off. -
#attrset(attrs) ⇒ Object
Sets the current attributes of the given window to
attrs
. -
#begx ⇒ Object
A getter for the beginning column (X coord) of the window.
-
#begy ⇒ Object
A getter for the beginning line (Y coord) of the window.
-
#bkgd(ch) ⇒ Object
Set the background of the current window and apply character Integer
ch
to every character. -
#bkgdset(ch) ⇒ Object
Manipulate the background of the current window with character Integer
ch
. -
#box(vert, hor) ⇒ Object
set the characters to frame the window in.
-
#clear ⇒ Object
Clear the window.
-
#close ⇒ Object
Deletes the window, and frees the memory.
-
#clrtoeol ⇒ Object
Clear the window to the end of line, that the cursor is currently on.
-
#color_set(col) ⇒ Object
Sets the current color of the given window to the foreground/background combination described by the Fixnum
col
. -
#curx ⇒ Object
A getter for the current column (X coord) of the window.
-
#cury ⇒ Object
A getter for the current line (Y coord) of the window.
-
#delch ⇒ Object
Delete the character under the cursor.
-
#deleteln ⇒ Object
Delete the line under the cursor.
-
#getbkgd ⇒ Object
Returns an Interer (
ch
) for the character property in the current window. -
#getch ⇒ Object
Read and returns a character from the window.
-
#getstr ⇒ Object
This is equivalent to a series f Curses::Window.getch calls.
-
#idlok(bool) ⇒ Object
If
bool
istrue
curses considers using the hardware insert/delete line feature of terminals so equipped. -
#inch ⇒ Object
Returns the character at the current position of the window.
-
#new(height, width, top, left) ⇒ Object
constructor
Contruct a new Curses::Window with constraints of
height
lines,width
columns, begin attop
line, and beginleft
most column. -
#insch(ch) ⇒ Object
Insert a character
ch
, before the cursor, in the current window. -
#insertln ⇒ Object
Inserts a line above the cursor, and the bottom line is lost.
-
#keypad(bool) ⇒ Object
Enables the keypad of the user's terminal.
-
#keypad(bool) ⇒ Object
Enables the keypad of the user's terminal.
-
#maxx ⇒ Object
A getter for the maximum columns for the window.
-
#maxy ⇒ Object
A getter for the maximum lines for the window.
-
#move(y, x) ⇒ Object
Moves the window so that the upper left-hand corner is at position (
y
,x
). -
#nodelay(bool) ⇒ Object
Causes Curses::Window.getch to be a non-blocking call.
-
#noutrefresh ⇒ Object
Refreshes the windows and lines.
-
#refresh ⇒ Object
Refreshes the windows and lines.
-
#resize(lines, cols) ⇒ Object
Resize the current window to Fixnum
lines
and Fixnumcols
. -
#scrl(num) ⇒ Object
Scrolls the current window Fixnum
num
lines. -
#scroll ⇒ Object
Scrolls the current window up one line.
-
#scrollok(bool) ⇒ Object
Controls what happens when the cursor of a window is moved off the edge of the window or scrolling region, either as a result of a newline action on the bottom line, or typing the last character of the last line.
-
#setpos(y, x) ⇒ Object
A setter for the position of the cursor in the current window, using coordinates
x
andy
. -
#setscrreg(top, bottom) ⇒ Object
Set a software scrolling region in a window.
-
#standend ⇒ Object
Enables the Normal display (no highlight).
-
#standout ⇒ Object
Enables the best highlighting mode of the terminal.
-
#subwin(height, width, top, left) ⇒ Object
Contruct a new subwindow with constraints of
height
lines,width
columns, begin attop
line, and beginleft
most column. -
#timeout=(delay) ⇒ Object
Sets block and non-blocking reads for the window.
Constructor Details
#new(height, width, top, left) ⇒ Object
Contruct a new Curses::Window with constraints of height
lines, width
columns, begin at top
line, and begin left
most column.
A new window using full screen is called as Curses::Window.new(0,0,0,0)
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 |
# File 'curses.c', line 1454
static VALUE
window_initialize(VALUE obj, VALUE h, VALUE w, VALUE top, VALUE left)
{
struct windata *winp;
WINDOW *window;
rb_secure(4);
curses_init_screen();
Data_Get_Struct(obj, struct windata, winp);
if (winp->window) delwin(winp->window);
window = newwin(NUM2INT(h), NUM2INT(w), NUM2INT(top), NUM2INT(left));
wclear(window);
winp->window = window;
return obj;
}
|
Instance Method Details
#<< ⇒ Object
call-seq:
<<(str)
Add String str
to the current string.
See also Curses::Window.addstr
1907 1908 1909 1910 1911 1912 |
# File 'curses.c', line 1907
static VALUE
window_addstr2(VALUE obj, VALUE str)
{
window_addstr(obj, str);
return obj;
}
|
#addch(ch) ⇒ Object
Add a character ch
, with attributes, to the window, then advance the cursor.
see also the system manual for curs_addch(3)
1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 |
# File 'curses.c', line 1847
static VALUE
window_addch(VALUE obj, VALUE ch)
{
struct windata *winp;
GetWINDOW(obj, winp);
waddch(winp->window, NUM2CH(ch));
return Qnil;
}
|
#addstr(str) ⇒ Object
add a string of characters str
, to the window and advance cursor
1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 |
# File 'curses.c', line 1883
static VALUE
window_addstr(VALUE obj, VALUE str)
{
if (!NIL_P(str)) {
struct windata *winp;
StringValue(str);
str = rb_str_export_locale(str);
GetWINDOW(obj, winp);
waddstr(winp->window, StringValueCStr(str));
}
return Qnil;
}
|
#attroff(attrs) ⇒ Object
Turns on the named attributes attrs
without affecting any others.
See also Curses::Window.attrset
2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 |
# File 'curses.c', line 2192
static VALUE
window_attroff(VALUE obj, VALUE attrs)
{
#ifdef HAVE_WATTROFF
struct windata *winp;
GetWINDOW(obj,winp);
return INT2FIX(wattroff(winp->window,NUM2INT(attrs)));
#else
return Qtrue;
#endif
}
|
#attron(attrs) ⇒ Object
Turns off the named attributes attrs
without turning any other attributes on or off.
See also Curses::Window.attrset
2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 |
# File 'curses.c', line 2214
static VALUE
window_attron(VALUE obj, VALUE attrs)
{
#ifdef HAVE_WATTRON
struct windata *winp;
VALUE val;
GetWINDOW(obj,winp);
val = INT2FIX(wattron(winp->window,NUM2INT(attrs)));
if (rb_block_given_p()) {
rb_yield(val);
wattroff(winp->window,NUM2INT(attrs));
return val;
}
else{
return val;
}
#else
return Qtrue;
#endif
}
|
#attrset(attrs) ⇒ Object
Sets the current attributes of the given window to attrs
.
The following video attributes, defined in <curses.h>, can be passed to the routines Curses::Window.attron, Curses::Window.attroff, and Curses::Window.attrset, or OR'd with the characters passed to addch.
A_NORMAL Normal display (no highlight)
A_STANDOUT Best highlighting mode of the terminal.
A_UNDERLINE Underlining
A_REVERSE Reverse video
A_BLINK Blinking
A_DIM Half bright
A_BOLD Extra bright or bold
A_PROTECT Protected mode
A_INVIS Invisible or blank mode
A_ALTCHARSET Alternate character set
A_CHARTEXT Bit-mask to extract a character
COLOR_PAIR(n) Color-pair number n
TODO: provide some examples here.
see also system manual curs_attr(3)
2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 |
# File 'curses.c', line 2262
static VALUE
window_attrset(VALUE obj, VALUE attrs)
{
#ifdef HAVE_WATTRSET
struct windata *winp;
GetWINDOW(obj,winp);
return INT2FIX(wattrset(winp->window,NUM2INT(attrs)));
#else
return Qtrue;
#endif
}
|
#begx ⇒ Object
A getter for the beginning column (X coord) of the window
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 |
# File 'curses.c', line 1728
static VALUE
window_begx(VALUE obj)
{
struct windata *winp;
int x, y;
GetWINDOW(obj, winp);
#ifdef getbegyx
getbegyx(winp->window, y, x);
return INT2FIX(x);
#else
return INT2FIX(winp->window->_begx);
#endif
}
|
#begy ⇒ Object
A getter for the beginning line (Y coord) of the window
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 |
# File 'curses.c', line 1708
static VALUE
window_begy(VALUE obj)
{
struct windata *winp;
int x, y;
GetWINDOW(obj, winp);
#ifdef getbegyx
getbegyx(winp->window, y, x);
return INT2FIX(y);
#else
return INT2FIX(winp->window->_begy);
#endif
}
|
#bkgd(ch) ⇒ Object
Set the background of the current window and apply character Integer ch
to every character.
see also Curses.bkgd
2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'curses.c', line 2305
static VALUE
window_bkgd(VALUE obj, VALUE ch)
{
#ifdef HAVE_WBKGD
struct windata *winp;
GetWINDOW(obj,winp);
return (wbkgd(winp->window, NUM2CH(ch)) == OK) ? Qtrue : Qfalse;
#else
return Qfalse;
#endif
}
|
#bkgdset(ch) ⇒ Object
Manipulate the background of the current window with character Integer ch
see also Curses.bkgdset
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 |
# File 'curses.c', line 2284
static VALUE
window_bkgdset(VALUE obj, VALUE ch)
{
#ifdef HAVE_WBKGDSET
struct windata *winp;
GetWINDOW(obj,winp);
wbkgdset(winp->window, NUM2CH(ch));
#endif
return Qnil;
}
|
#box(vert, hor) ⇒ Object
set the characters to frame the window in. The vertical vert
and horizontal hor
character.
win = Curses::Window.new(5,5,5,5) win.box(?|, ?-)
1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 |
# File 'curses.c', line 1754
static VALUE
window_box(int argc, VALUE *argv, VALUE self)
{
struct windata *winp;
VALUE vert, hor, corn;
rb_scan_args(argc, argv, "21", &vert, &hor, &corn);
GetWINDOW(self, winp);
box(winp->window, NUM2CH(vert), NUM2CH(hor));
if (!NIL_P(corn)) {
int cur_x, cur_y, x, y;
chtype c;
c = NUM2CH(corn);
getyx(winp->window, cur_y, cur_x);
x = NUM2INT(window_maxx(self)) - 1;
y = NUM2INT(window_maxy(self)) - 1;
wmove(winp->window, 0, 0);
waddch(winp->window, c);
wmove(winp->window, y, 0);
waddch(winp->window, c);
wmove(winp->window, y, x);
waddch(winp->window, c);
wmove(winp->window, 0, x);
waddch(winp->window, c);
wmove(winp->window, cur_y, cur_x);
}
return Qnil;
}
|
#clear ⇒ Object
Clear the window.
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 |
# File 'curses.c', line 1520
static VALUE
window_clear(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wclear(winp->window);
return Qnil;
}
|
#close ⇒ Object
Deletes the window, and frees the memory
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 |
# File 'curses.c', line 1503
static VALUE
window_close(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
delwin(winp->window);
winp->window = 0;
return Qnil;
}
|
#clrtoeol ⇒ Object
Clear the window to the end of line, that the cursor is currently on.
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 |
# File 'curses.c', line 1536
static VALUE
window_clrtoeol(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wclrtoeol(winp->window);
return Qnil;
}
|
#color_set(col) ⇒ Object
Sets the current color of the given window to the foreground/background combination described by the Fixnum col
.
2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 |
# File 'curses.c', line 2131
static VALUE
window_color_set(VALUE obj, VALUE col)
{
struct windata *winp;
int res;
GetWINDOW(obj, winp);
res = wcolor_set(winp->window, NUM2INT(col), NULL);
return (res == OK) ? Qtrue : Qfalse;
}
|
#curx ⇒ Object
A getter for the current column (X coord) of the window
1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 |
# File 'curses.c', line 1644
static VALUE
window_curx(VALUE obj)
{
struct windata *winp;
int x, y;
GetWINDOW(obj, winp);
getyx(winp->window, y, x);
return INT2FIX(x);
}
|
#cury ⇒ Object
A getter for the current line (Y coord) of the window
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 |
# File 'curses.c', line 1628
static VALUE
window_cury(VALUE obj)
{
struct windata *winp;
int x, y;
GetWINDOW(obj, winp);
getyx(winp->window, y, x);
return INT2FIX(y);
}
|
#delch ⇒ Object
Delete the character under the cursor
1996 1997 1998 1999 2000 2001 2002 2003 2004 |
# File 'curses.c', line 1996
static VALUE
window_delch(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wdelch(winp->window);
return Qnil;
}
|
#deleteln ⇒ Object
Delete the line under the cursor.
2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 |
# File 'curses.c', line 2012
static VALUE
window_deleteln(VALUE obj)
{
#if defined(HAVE_WDELETELN) || defined(wdeleteln)
struct windata *winp;
GetWINDOW(obj, winp);
wdeleteln(winp->window);
#endif
return Qnil;
}
|
#getbkgd ⇒ Object
Returns an Interer (ch
) for the character property in the current window.
2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 |
# File 'curses.c', line 2323
static VALUE
window_getbkgd(VALUE obj)
{
#ifdef HAVE_WGETBKGD
chtype c;
struct windata *winp;
GetWINDOW(obj,winp);
return (c = getbkgd(winp->window) != ERR) ? CH2FIX(c) : Qnil;
#else
return Qnil;
#endif
}
|
#getch ⇒ Object
Read and returns a character from the window.
See Curses::Key to all the function KEY_* available
1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 |
# File 'curses.c', line 1935
static VALUE
window_getch(VALUE obj)
{
struct windata *winp;
struct wgetch_arg arg;
int c;
GetWINDOW(obj, winp);
arg.win = winp->window;
rb_thread_blocking_region(wgetch_func, (void *)&arg, RUBY_UBF_IO, 0);
c = arg.c;
if (c == EOF) return Qnil;
if (rb_isprint(c)) {
char ch = (char)c;
return rb_locale_str_new(&ch, 1);
}
return UINT2NUM(c);
}
|
#getstr ⇒ Object
This is equivalent to a series f Curses::Window.getch calls
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 |
# File 'curses.c', line 1978
static VALUE
window_getstr(VALUE obj)
{
struct windata *winp;
struct wgetstr_arg arg;
GetWINDOW(obj, winp);
arg.win = winp->window;
rb_thread_blocking_region(wgetstr_func, (void *)&arg, RUBY_UBF_IO, 0);
return rb_locale_str_new_cstr(arg.rtn);
}
|
#idlok(bool) ⇒ Object
If bool
is true
curses considers using the hardware insert/delete line feature of terminals so equipped.
If bool
is false
, disables use of line insertion and deletion. This option should be enabled only if the application needs insert/delete line, for example, for a screen editor.
It is disabled by default because insert/delete line tends to be visually annoying when used in applications where it is not really needed. If insert/delete line cannot be used, curses redraws the changed portions of all lines.
2083 2084 2085 2086 2087 2088 2089 2090 2091 |
# File 'curses.c', line 2083
static VALUE
window_idlok(VALUE obj, VALUE bf)
{
struct windata *winp;
GetWINDOW(obj, winp);
idlok(winp->window, RTEST(bf) ? TRUE : FALSE);
return Qnil;
}
|
#inch ⇒ Object
Returns the character at the current position of the window.
1830 1831 1832 1833 1834 1835 1836 1837 |
# File 'curses.c', line 1830
static VALUE
window_inch(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
return CH2FIX(winch(winp->window));
}
|
#insch(ch) ⇒ Object
Insert a character ch
, before the cursor, in the current window
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 |
# File 'curses.c', line 1865
static VALUE
window_insch(VALUE obj, VALUE ch)
{
struct windata *winp;
GetWINDOW(obj, winp);
winsch(winp->window, NUM2CH(ch));
return Qnil;
}
|
#insertln ⇒ Object
Inserts a line above the cursor, and the bottom line is lost
2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 |
# File 'curses.c', line 2030
static VALUE
window_insertln(VALUE obj)
{
#if defined(HAVE_WINSERTLN) || defined(winsertln)
struct windata *winp;
GetWINDOW(obj, winp);
winsertln(winp->window);
#endif
return Qnil;
}
|
#keypad(bool) ⇒ Object
Enables the keypad of the user's terminal.
If enabled (bool
is true
), the user can press a function key (such as an arrow key) and wgetch returns a single value representing the function key, as in KEY_LEFT. If disabled (bool
is false
), curses does not treat function keys specially and the program has to interpret the escape sequences itself. If the keypad in the terminal can be turned on (made to transmit) and off (made to work locally), turning on this option causes the terminal keypad to be turned on when Curses::Window.getch is called.
The default value for keypad is false.
2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 |
# File 'curses.c', line 2386
static VALUE
window_keypad(VALUE obj, VALUE val)
{
struct windata *winp;
GetWINDOW(obj,winp);
/* keypad() of NetBSD's libcurses returns no value */
#if defined(__NetBSD__) && !defined(NCURSES_VERSION)
keypad(winp->window,(RTEST(val) ? TRUE : FALSE));
return Qnil;
#else
/* may have to raise exception on ERR */
return (keypad(winp->window,RTEST(val) ? TRUE : FALSE)) == OK ?
Qtrue : Qfalse;
#endif
}
|
#keypad(bool) ⇒ Object
Enables the keypad of the user's terminal.
If enabled (bool
is true
), the user can press a function key (such as an arrow key) and wgetch returns a single value representing the function key, as in KEY_LEFT. If disabled (bool
is false
), curses does not treat function keys specially and the program has to interpret the escape sequences itself. If the keypad in the terminal can be turned on (made to transmit) and off (made to work locally), turning on this option causes the terminal keypad to be turned on when Curses::Window.getch is called.
The default value for keypad is false.
2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 |
# File 'curses.c', line 2386
static VALUE
window_keypad(VALUE obj, VALUE val)
{
struct windata *winp;
GetWINDOW(obj,winp);
/* keypad() of NetBSD's libcurses returns no value */
#if defined(__NetBSD__) && !defined(NCURSES_VERSION)
keypad(winp->window,(RTEST(val) ? TRUE : FALSE));
return Qnil;
#else
/* may have to raise exception on ERR */
return (keypad(winp->window,RTEST(val) ? TRUE : FALSE)) == OK ?
Qtrue : Qfalse;
#endif
}
|
#maxx ⇒ Object
A getter for the maximum columns for the window
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 |
# File 'curses.c', line 1684
static VALUE
window_maxx(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
#if defined(getmaxx)
return INT2FIX(getmaxx(winp->window));
#elif defined(getmaxyx)
{
int x, y;
getmaxyx(winp->window, y, x);
return INT2FIX(x);
}
#else
return INT2FIX(winp->window->_maxx+1);
#endif
}
|
#maxy ⇒ Object
A getter for the maximum lines for the window
1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 |
# File 'curses.c', line 1660
static VALUE
window_maxy(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
#if defined(getmaxy)
return INT2FIX(getmaxy(winp->window));
#elif defined(getmaxyx)
{
int x, y;
getmaxyx(winp->window, y, x);
return INT2FIX(y);
}
#else
return INT2FIX(winp->window->_maxy+1);
#endif
}
|
#move(y, x) ⇒ Object
Moves the window so that the upper left-hand corner is at position (y
, x
)
1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 |
# File 'curses.c', line 1593
static VALUE
window_move(VALUE obj, VALUE y, VALUE x)
{
struct windata *winp;
GetWINDOW(obj, winp);
mvwin(winp->window, NUM2INT(y), NUM2INT(x));
return Qnil;
}
|
#nodelay(bool) ⇒ Object
Causes Curses::Window.getch to be a non-blocking call. If no input is ready, getch returns ERR.
If disabled (bool
is false
), Curses::Window.getch waits until a key is pressed.
2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 |
# File 'curses.c', line 2416
static VALUE
window_nodelay(VALUE obj, VALUE val)
{
struct windata *winp;
GetWINDOW(obj,winp);
/* nodelay() of NetBSD's libcurses returns no value */
#if defined(__NetBSD__) && !defined(NCURSES_VERSION)
nodelay(winp->window, RTEST(val) ? TRUE : FALSE);
return Qnil;
#else
return nodelay(winp->window,RTEST(val) ? TRUE : FALSE) == OK ? Qtrue : Qfalse;
#endif
}
|
#noutrefresh ⇒ Object
Refreshes the windows and lines.
Curses::Window.noutrefresh allows multiple updates with more efficiency than Curses::Window.refresh alone.
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 |
# File 'curses.c', line 1572
static VALUE
window_noutrefresh(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
#ifdef HAVE_DOUPDATE
wnoutrefresh(winp->window);
#else
wrefresh(winp->window);
#endif
return Qnil;
}
|
#refresh ⇒ Object
Refreshes the windows and lines.
1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 |
# File 'curses.c', line 1553
static VALUE
window_refresh(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wrefresh(winp->window);
return Qnil;
}
|
#resize(lines, cols) ⇒ Object
Resize the current window to Fixnum lines
and Fixnum cols
2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 |
# File 'curses.c', line 2344
static VALUE
window_resize(VALUE obj, VALUE lin, VALUE col)
{
#if defined(HAVE_WRESIZE)
struct windata *winp;
GetWINDOW(obj,winp);
return wresize(winp->window, NUM2INT(lin), NUM2INT(col)) == OK ? Qtrue : Qfalse;
#else
return Qnil;
#endif
}
|
#scrl(num) ⇒ Object
Scrolls the current window Fixnum num
lines. The current cursor position is not changed.
For positive num
, it scrolls up.
For negative num
, it scrolls down.
2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 |
# File 'curses.c', line 2170
static VALUE
window_scrl(VALUE obj, VALUE n)
{
#ifdef HAVE_WSCRL
struct windata *winp;
GetWINDOW(obj, winp);
/* may have to raise exception on ERR */
return (wscrl(winp->window,NUM2INT(n)) == OK) ? Qtrue : Qfalse;
#else
return Qfalse;
#endif
}
|
#scroll ⇒ Object
Scrolls the current window up one line.
2148 2149 2150 2151 2152 2153 2154 2155 2156 |
# File 'curses.c', line 2148
static VALUE
window_scroll(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
/* may have to raise exception on ERR */
return (scroll(winp->window) == OK) ? Qtrue : Qfalse;
}
|
#scrollok(bool) ⇒ Object
Controls what happens when the cursor of a window is moved off the edge of the window or scrolling region, either as a result of a newline action on the bottom line, or typing the last character of the last line.
If disabled, (bool
is false), the cursor is left on the bottom line.
If enabled, (bool
is true), the window is scrolled up one line (Note that to get the physical scrolling effect on the terminal, it is also necessary to call Curses::Window.idlok)
2057 2058 2059 2060 2061 2062 2063 2064 2065 |
# File 'curses.c', line 2057
static VALUE
window_scrollok(VALUE obj, VALUE bf)
{
struct windata *winp;
GetWINDOW(obj, winp);
scrollok(winp->window, RTEST(bf) ? TRUE : FALSE);
return Qnil;
}
|
#setpos(y, x) ⇒ Object
A setter for the position of the cursor in the current window, using coordinates x
and y
1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'curses.c', line 1613
static VALUE
window_setpos(VALUE obj, VALUE y, VALUE x)
{
struct windata *winp;
GetWINDOW(obj, winp);
wmove(winp->window, NUM2INT(y), NUM2INT(x));
return Qnil;
}
|
#setscrreg(top, bottom) ⇒ Object
Set a software scrolling region in a window. top
and bottom
are lines numbers of the margin.
If this option and Curses::Window.scrollok are enabled, an attempt to move off the bottom margin line causes all lines in the scrolling region to scroll one line in the direction of the first line. Only the text of the window is scrolled.
2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 |
# File 'curses.c', line 2107
static VALUE
window_setscrreg(VALUE obj, VALUE top, VALUE bottom)
{
#ifdef HAVE_WSETSCRREG
struct windata *winp;
int res;
GetWINDOW(obj, winp);
res = wsetscrreg(winp->window, NUM2INT(top), NUM2INT(bottom));
/* may have to raise exception on ERR */
return (res == OK) ? Qtrue : Qfalse;
#else
return Qfalse;
#endif
}
|
#standend ⇒ Object
Enables the Normal display (no highlight)
This is equivalent to Curses::Window.attron(A_NORMAL)
see also Curses::Window.attrset
1815 1816 1817 1818 1819 1820 1821 1822 1823 |
# File 'curses.c', line 1815
static VALUE
window_standend(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wstandend(winp->window);
return Qnil;
}
|
#standout ⇒ Object
Enables the best highlighting mode of the terminal.
This is equivalent to Curses::Window.attron(A_STANDOUT)
see also Curses::Window.attrset
1796 1797 1798 1799 1800 1801 1802 1803 1804 |
# File 'curses.c', line 1796
static VALUE
window_standout(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wstandout(winp->window);
return Qnil;
}
|
#subwin(height, width, top, left) ⇒ Object
Contruct a new subwindow with constraints of height
lines, width
columns, begin at top
line, and begin left
most column.
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 |
# File 'curses.c', line 1479
static VALUE
window_subwin(VALUE obj, VALUE height, VALUE width, VALUE top, VALUE left)
{
struct windata *winp;
WINDOW *window;
VALUE win;
int h, w, t, l;
h = NUM2INT(height);
w = NUM2INT(width);
t = NUM2INT(top);
l = NUM2INT(left);
GetWINDOW(obj, winp);
window = subwin(winp->window, h, w, t, l);
win = prep_window(rb_obj_class(obj), window);
return win;
}
|
#timeout=(delay) ⇒ Object
Sets block and non-blocking reads for the window.
-
If delay is negative, blocking read is used (i.e., waits indefinitely for input).
-
If delay is zero, then non-blocking read is used (i.e., read returns ERR if no input is waiting).
-
If delay is positive, then read blocks for delay milliseconds, and returns ERR if there is still no input.
2445 2446 2447 2448 2449 2450 2451 2452 2453 |
# File 'curses.c', line 2445
static VALUE
window_timeout(VALUE obj, VALUE delay)
{
struct windata *winp;
GetWINDOW(obj,winp);
wtimeout(winp->window,NUM2INT(delay));
return Qnil;
}
|