Class: Curses::Window
- Inherits:
-
Data
- Object
- Data
- Curses::Window
- Defined in:
- ext/curses/curses.c,
ext/curses/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!"
height, width = 12, my_str.length + 10
top, left = (Curses.lines - height) / 2, (Curses.cols - width) / 2
bwin = Curses::Window.new(height, width, top, left)
bwin.box("\\", "/")
bwin.refresh
win = bwin.subwin(height - 4, width - 4, top + 2, left + 2)
win.setpos(2, 3)
win.addstr(my_str)
# or even
win << "\nOH REALLY?"
win << "\nYES!! " + my_str
win.refresh
win.getch
win.close
Direct Known Subclasses
Instance Method Summary collapse
-
#<<(str) ⇒ 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 off the named attributes
attrs
without affecting any others. -
#attron(attrs) ⇒ Object
Turns on 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.
-
#erase ⇒ Object
Erase the window.
-
#get_char ⇒ Object
Read and returns a character or function key from the window.
-
#getbkgd ⇒ Object
Returns an Integer (
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
Construct 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.
-
#line_touched?(line) ⇒ Boolean
Return true if the specified line has been modified since the last call of refresh.
-
#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
When in no-delay mode Curses::Window#getch is a non-blocking call.
-
#noutrefresh ⇒ Object
Refreshes the windows and lines.
-
#redraw ⇒ Object
Redraws the entire window.
-
#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
Construct 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.
-
#touch ⇒ Object
Treat the window as if it has been modified since the last call of refresh.
-
#touch_line(y, n, changed = true) ⇒ Object
Make n lines from line y look as if they have (changed = true) or have not (changed = false) been modified since the last call of refresh.
-
#touched? ⇒ Boolean
Return true if the window has been modified since the last call of refresh.
-
#untouch ⇒ Object
Treat the window as if it has not been modified since the last call of refresh.
Constructor Details
#new(height, width, top, left) ⇒ Object
Construct 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)
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 |
# File 'ext/curses/curses.c', line 1549
static VALUE
window_initialize(VALUE obj, VALUE h, VALUE w, VALUE top, VALUE left)
{
struct windata *winp;
WINDOW *window;
curses_init_screen();
TypedData_Get_Struct(obj, struct windata, &windata_type, 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
#<<(str) ⇒ Object
call-seq:
<<(str)
Add String str
to the current string.
See also Curses::Window.addstr
2166 2167 2168 2169 2170 2171 |
# File 'ext/curses/curses.c', line 2166
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)
2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 |
# File 'ext/curses/curses.c', line 2100
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
2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 |
# File 'ext/curses/curses.c', line 2136
static VALUE
window_addstr(VALUE obj, VALUE str)
{
if (!NIL_P(str)) {
struct windata *winp;
StringValue(str);
#if defined(HAVE_WADDNWSTR) && defined(_WIN32)
str = rb_str_export_to_enc(str, get_wide_encoding());
GetWINDOW(obj, winp);
waddnwstr(winp->window, (wchar_t *)RSTRING_PTR(str), RSTRING_LEN(str) / sizeof(wchar_t));
#else
str = rb_str_export_to_enc(str, terminal_encoding);
GetWINDOW(obj, winp);
waddstr(winp->window, StringValueCStr(str));
#endif
}
return Qnil;
}
|
#attroff(attrs) ⇒ Object
Turns off the named attributes attrs
without affecting any others.
See also Curses::Window.attrset
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 |
# File 'ext/curses/curses.c', line 2453
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 on the named attributes attrs
without turning any other attributes on or off.
See also Curses::Window.attrset
2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 |
# File 'ext/curses/curses.c', line 2475
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)
2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 |
# File 'ext/curses/curses.c', line 2523
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
1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 |
# File 'ext/curses/curses.c', line 1981
static VALUE
window_begx(VALUE obj)
{
struct windata *winp;
int x, RB_UNUSED_VAR(y);
GetWINDOW(obj, winp);
#ifdef getbegyx
getbegyx(winp->window, y, x);
#else
x = winp->window->_begx;
#endif
return INT2FIX(x);
}
|
#begy ⇒ Object
A getter for the beginning line (Y coord) of the window
1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 |
# File 'ext/curses/curses.c', line 1961
static VALUE
window_begy(VALUE obj)
{
struct windata *winp;
int RB_UNUSED_VAR(x), y;
GetWINDOW(obj, winp);
#ifdef getbegyx
getbegyx(winp->window, y, x);
#else
y = winp->window->_begy;
#endif
return INT2FIX(y);
}
|
#bkgd(ch) ⇒ Object
Set the background of the current window and apply character Integer ch
to every character.
see also Curses.bkgd
2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 |
# File 'ext/curses/curses.c', line 2566
static VALUE
window_bkgd(VALUE obj, VALUE ch)
{
#ifdef HAVE_WBKGD
struct windata *winp;
GetWINDOW(obj,winp);
return (wbkgd(winp->window, NUM2CHTYPE(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
2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 |
# File 'ext/curses/curses.c', line 2545
static VALUE
window_bkgdset(VALUE obj, VALUE ch)
{
#ifdef HAVE_WBKGDSET
struct windata *winp;
GetWINDOW(obj,winp);
wbkgdset(winp->window, NUM2CHTYPE(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(?|, ?-)
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 |
# File 'ext/curses/curses.c', line 2007
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.
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 |
# File 'ext/curses/curses.c', line 1614
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
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 |
# File 'ext/curses/curses.c', line 1597
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.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 |
# File 'ext/curses/curses.c', line 1650
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
.
2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 |
# File 'ext/curses/curses.c', line 2391
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
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 |
# File 'ext/curses/curses.c', line 1897
static VALUE
window_curx(VALUE obj)
{
struct windata *winp;
int x, RB_UNUSED_VAR(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
1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 |
# File 'ext/curses/curses.c', line 1881
static VALUE
window_cury(VALUE obj)
{
struct windata *winp;
int RB_UNUSED_VAR(x), y;
GetWINDOW(obj, winp);
getyx(winp->window, y, x);
return INT2FIX(y);
}
|
#delch ⇒ Object
Delete the character under the cursor
2256 2257 2258 2259 2260 2261 2262 2263 2264 |
# File 'ext/curses/curses.c', line 2256
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.
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 |
# File 'ext/curses/curses.c', line 2272
static VALUE
window_deleteln(VALUE obj)
{
#if defined(HAVE_WDELETELN) || defined(wdeleteln)
struct windata *winp;
GetWINDOW(obj, winp);
wdeleteln(winp->window);
#endif
return Qnil;
}
|
#erase ⇒ Object
Erase the window.
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'ext/curses/curses.c', line 1631
static VALUE
window_erase(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
werase(winp->window);
return Qnil;
}
|
#get_char ⇒ Object
Read and returns a character or function key from the window. A single or multibyte character is represented by a String, and a function key is represented by an Integer. Returns nil if no input is ready.
See Curses::Key to all the function KEY_* available
3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 |
# File 'ext/curses/curses.c', line 3025
static VALUE
window_get_char(VALUE obj)
{
#ifdef HAVE_WGET_WCH
struct windata *winp;
struct wget_wch_arg arg;
GetWINDOW(obj, winp);
arg.win = winp->window;
rb_thread_call_without_gvl(wget_wch_func, &arg, RUBY_UBF_IO, 0);
switch (arg.retval) {
case OK:
return keyboard_uint_chr(arg.ch);
case KEY_CODE_YES:
return UINT2NUM(arg.ch);
}
return Qnil;
#else
struct windata *winp;
struct wgetch_arg arg;
GetWINDOW(obj, winp);
arg.win = winp->window;
rb_thread_call_without_gvl(wgetch_func, (void *)&arg, RUBY_UBF_IO, 0);
if (arg.c > 0xff) {
return INT2NUM(arg.c);
}
else if (arg.c >= 0) {
return keyboard_uint_chr(arg.c);
}
else {
return Qnil;
}
#endif
}
|
#getbkgd ⇒ Object
Returns an Integer (ch
) for the character property in the current window.
2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 |
# File 'ext/curses/curses.c', line 2584
static VALUE
window_getbkgd(VALUE obj)
{
#ifdef HAVE_WGETBKGD
chtype c;
struct windata *winp;
GetWINDOW(obj,winp);
return (c = getbkgd(winp->window) != ERR) ? ULONG2NUM(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
2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 |
# File 'ext/curses/curses.c', line 2194
static VALUE
window_getch(VALUE obj)
{
struct windata *winp;
struct wgetch_arg arg;
int c;
GetWINDOW(obj, winp);
arg.win = winp->window;
rb_thread_call_without_gvl(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_external_str_new_with_enc(&ch, 1, keyboard_encoding);
}
return UINT2NUM(c);
}
|
#getstr ⇒ Object
This is equivalent to a series f Curses::Window.getch calls
2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 |
# File 'ext/curses/curses.c', line 2237
static VALUE
window_getstr(VALUE obj)
{
struct windata *winp;
struct wgetstr_arg arg;
GetWINDOW(obj, winp);
arg.win = winp->window;
rb_thread_call_without_gvl(wgetstr_func, (void *)&arg, RUBY_UBF_IO, 0);
return rb_external_str_new_with_enc(arg.rtn, strlen(arg.rtn),
keyboard_encoding);
}
|
#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.
2343 2344 2345 2346 2347 2348 2349 2350 2351 |
# File 'ext/curses/curses.c', line 2343
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.
2083 2084 2085 2086 2087 2088 2089 2090 |
# File 'ext/curses/curses.c', line 2083
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
2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 |
# File 'ext/curses/curses.c', line 2118
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
2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 |
# File 'ext/curses/curses.c', line 2290
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.
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 |
# File 'ext/curses/curses.c', line 2647
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.
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 |
# File 'ext/curses/curses.c', line 2647
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
}
|
#line_touched?(line) ⇒ Boolean
Return true if the specified line has been modified since the last call of refresh.
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 |
# File 'ext/curses/curses.c', line 1822
static VALUE
window_line_touched(VALUE obj, VALUE line)
{
struct windata *winp;
int result, n;
GetWINDOW(obj, winp);
n = NUM2INT(line);
result = is_linetouched(winp->window, n);
if (result == ERR) {
rb_raise(rb_eArgError, "Invalid line %d", n);
}
return result ? Qtrue : Qfalse;
}
|
#maxx ⇒ Object
A getter for the maximum columns for the window
1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 |
# File 'ext/curses/curses.c', line 1937
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, RB_UNUSED_VAR(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
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 |
# File 'ext/curses/curses.c', line 1913
static VALUE
window_maxy(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
#if defined(getmaxy)
return INT2FIX(getmaxy(winp->window));
#elif defined(getmaxyx)
{
int RB_UNUSED_VAR(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
)
1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 |
# File 'ext/curses/curses.c', line 1846
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
When in no-delay mode Curses::Window#getch is a non-blocking call. If no input is ready #getch returns ERR.
When in delay mode (bool
is false
which is the default), Curses::Window#getch blocks until a key is pressed.
2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 |
# File 'ext/curses/curses.c', line 2680
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.
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 |
# File 'ext/curses/curses.c', line 1686
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;
}
|
#redraw ⇒ Object
Redraws the entire window.
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 |
# File 'ext/curses/curses.c', line 1707
static VALUE
window_redraw(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
redrawwin(winp->window);
return Qnil;
}
|
#refresh ⇒ Object
Refreshes the windows and lines.
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 |
# File 'ext/curses/curses.c', line 1667
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
2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 |
# File 'ext/curses/curses.c', line 2605
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.
2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 |
# File 'ext/curses/curses.c', line 2430
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.
2408 2409 2410 2411 2412 2413 2414 2415 2416 |
# File 'ext/curses/curses.c', line 2408
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)
2317 2318 2319 2320 2321 2322 2323 2324 2325 |
# File 'ext/curses/curses.c', line 2317
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
1866 1867 1868 1869 1870 1871 1872 1873 1874 |
# File 'ext/curses/curses.c', line 1866
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.
2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 |
# File 'ext/curses/curses.c', line 2367
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
2068 2069 2070 2071 2072 2073 2074 2075 2076 |
# File 'ext/curses/curses.c', line 2068
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
2049 2050 2051 2052 2053 2054 2055 2056 2057 |
# File 'ext/curses/curses.c', line 2049
static VALUE
window_standout(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wstandout(winp->window);
return Qnil;
}
|
#subwin(height, width, top, left) ⇒ Object
Construct a new subwindow with constraints of height
lines, width
columns, begin at top
line, and begin left
most column.
1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 |
# File 'ext/curses/curses.c', line 1573
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.
2709 2710 2711 2712 2713 2714 2715 2716 2717 |
# File 'ext/curses/curses.c', line 2709
static VALUE
window_timeout(VALUE obj, VALUE delay)
{
struct windata *winp;
GetWINDOW(obj,winp);
wtimeout(winp->window,NUM2INT(delay));
return Qnil;
}
|
#touch ⇒ Object
Treat the window as if it has been modified since the last call of refresh.
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 |
# File 'ext/curses/curses.c', line 1727
static VALUE
window_touch(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
touchwin(winp->window);
return Qnil;
}
|
#touch_line(y, n, changed = true) ⇒ Object
Make n lines from line y look as if they have (changed = true) or have not (changed = false) been modified since the last call of refresh.
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 |
# File 'ext/curses/curses.c', line 1788
static VALUE
window_touch_line(int argc, VALUE *argv, VALUE obj)
{
struct windata *winp;
VALUE y, n, changed;
int result;
rb_scan_args(argc, argv, "12", &y, &n, &changed);
if (argc < 2) {
n = INT2NUM(1);
}
if (argc < 3) {
changed = Qtrue;
}
GetWINDOW(obj, winp);
result = wtouchln(winp->window, NUM2INT(y), NUM2INT(n), RTEST(changed));
if (result == ERR) {
rb_raise(rb_eRangeError, "Out of window");
}
return Qnil;
}
|
#touched? ⇒ Boolean
Return true if the window has been modified since the last call of refresh.
1768 1769 1770 1771 1772 1773 1774 1775 |
# File 'ext/curses/curses.c', line 1768
static VALUE
window_touched(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
return is_wintouched(winp->window) ? Qtrue : Qfalse;
}
|
#untouch ⇒ Object
Treat the window as if it has not been modified since the last call of refresh.
1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 |
# File 'ext/curses/curses.c', line 1748
static VALUE
window_untouch(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
untouchwin(winp->window);
return Qnil;
}
|