class Curses::Window
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
Public Class Methods
Source
static VALUE
window_initialize(VALUE obj, VALUE h, VALUE w, VALUE top, VALUE left)
{
struct windata *winp;
WINDOW *window;
curses_init_screen(Qnil);
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;
}
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)
Public Instance Methods
Source
static VALUE
window_addstr2(VALUE obj, VALUE str)
{
window_addstr(obj, str);
return obj;
}
Add String str to the current string.
See also Curses::Window.addstr
Source
static VALUE
window_addch(VALUE obj, VALUE ch)
{
struct windata *winp;
GetWINDOW(obj, winp);
waddch(winp->window, OBJ2CHTYPE(ch));
return Qnil;
}
Add a character ch, with attributes, to the window, then advance the cursor.
see also the system manual for curs_addch(3)
Source
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;
}
add a string of characters str, to the window and advance cursor
Source
static VALUE
window_attroff(VALUE obj, VALUE attrs)
{
#ifdef HAVE_WATTROFF
struct windata *winp;
GetWINDOW(obj,winp);
return INT2FIX(wattroff(winp->window,NUM2CHTYPE(attrs)));
#else
return Qtrue;
#endif
}
Turns off the named attributes attrs without affecting any others.
See also Curses::Window.attrset
Source
static VALUE
window_attron(VALUE obj, VALUE attrs)
{
#ifdef HAVE_WATTRON
struct windata *winp;
VALUE val;
GetWINDOW(obj,winp);
val = INT2FIX(wattron(winp->window,NUM2CHTYPE(attrs)));
if (rb_block_given_p()) {
rb_yield(val);
wattroff(winp->window,NUM2CHTYPE(attrs));
return val;
}
else{
return val;
}
#else
return Qtrue;
#endif
}
Turns on the named attributes attrs without turning any other attributes on or off.
See also Curses::Window.attrset
Source
static VALUE
window_attrset(VALUE obj, VALUE attrs)
{
#ifdef HAVE_WATTRSET
struct windata *winp;
GetWINDOW(obj,winp);
return INT2FIX(wattrset(winp->window,NUM2CHTYPE(attrs)));
#else
return Qtrue;
#endif
}
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)
Source
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);
}
A getter for the beginning column (X coord) of the window
Source
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);
}
A getter for the beginning line (Y coord) of the window
Source
static VALUE
window_bkgd(VALUE obj, VALUE ch)
{
#ifdef HAVE_WBKGD
struct windata *winp;
GetWINDOW(obj,winp);
return (wbkgd(winp->window, OBJ2CHTYPE(ch)) == OK) ? Qtrue : Qfalse;
#else
return Qfalse;
#endif
}
Set the background of the current window and apply character Integer ch to every character.
see also Curses.bkgd
Source
static VALUE
window_bkgdset(VALUE obj, VALUE ch)
{
#ifdef HAVE_WBKGDSET
struct windata *winp;
GetWINDOW(obj,winp);
wbkgdset(winp->window, OBJ2CHTYPE(ch));
#endif
return Qnil;
}
Manipulate the background of the current window with character Integer ch
see also Curses.bkgdset
Source
static VALUE
window_box(int argc, VALUE *argv, VALUE self)
{
struct windata *winp;
VALUE vert, hor, corn;
rb_scan_args(argc, argv, "03", &vert, &hor, &corn);
GetWINDOW(self, winp);
box(winp->window,
NIL_P(vert) ? 0 : OBJ2CHTYPE(vert),
NIL_P(hor) ? 0 : OBJ2CHTYPE(hor));
if (!NIL_P(corn)) {
int cur_x, cur_y, x, y;
chtype c;
c = OBJ2CHTYPE(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;
}
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(?|, ?-)
Source
static VALUE
window_chgat(VALUE obj, VALUE n, VALUE attrs)
{
#ifdef HAVE_WCHGAT
chtype a = NUM2CHTYPE(attrs);
attr_t attr;
short pair;
struct windata *winp;
GetWINDOW(obj,winp);
attr = a & A_ATTRIBUTES;
pair = PAIR_NUMBER(attr);
return (wchgat(winp->window, NUM2INT(n), attr, pair, NULL) == OK) ? Qtrue : Qfalse;
#else
return Qnil;
#endif
}
Changes the attributes of a given number of characters starting at the current cursor location.
Source
static VALUE
window_clear(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wclear(winp->window);
return Qnil;
}
Clear the window.
Source
static VALUE
window_close(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
delwin(winp->window);
winp->window = 0;
return Qnil;
}
Deletes the window, and frees the memory
Source
static VALUE
window_clrtoeol(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wclrtoeol(winp->window);
return Qnil;
}
Clear the window to the end of line, that the cursor is currently on.
Source
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;
}
Sets the current color of the given window to the foreground/background combination described by the Fixnum col.
Source
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);
}
A getter for the current column (X coord) of the window
Source
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);
}
A getter for the current line (Y coord) of the window
Source
static VALUE
window_delch(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wdelch(winp->window);
return Qnil;
}
Delete the character under the cursor
Source
static VALUE
window_deleteln(VALUE obj)
{
#if defined(HAVE_WDELETELN) || defined(wdeleteln)
struct windata *winp;
GetWINDOW(obj, winp);
wdeleteln(winp->window);
#endif
return Qnil;
}
Delete the line under the cursor.
Source
static VALUE
window_derwin(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 = derwin(winp->window, h, w, t, l);
win = prep_window(rb_obj_class(obj), window, 0);
return win;
}
Construct a new subwindow with constraints of height lines, width columns, begin at top line, and begin left most column relative to the parent window.
Source
static VALUE
window_erase(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
werase(winp->window);
return Qnil;
}
Erase the window.
Source
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 key_code_value(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
}
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
Source
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
}
Returns an Integer (ch) for the character property in the current window.
Source
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);
}
Read and returns a character from the window.
See Curses::Key to all the function KEY_* available
Source
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);
}
This is equivalent to a series of Curses::Window.getch calls
Source
static VALUE
window_idlok(VALUE obj, VALUE bf)
{
struct windata *winp;
GetWINDOW(obj, winp);
idlok(winp->window, RTEST(bf) ? TRUE : FALSE);
return Qnil;
}
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.
Source
static VALUE
window_inch(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
return CHTYPE2NUM(winch(winp->window));
}
Returns the character at the current position of the window.
Source
static VALUE
window_insch(VALUE obj, VALUE ch)
{
struct windata *winp;
GetWINDOW(obj, winp);
winsch(winp->window, OBJ2CHTYPE(ch));
return Qnil;
}
Insert a character ch, before the cursor, in the current window
Source
static VALUE
window_insertln(VALUE obj)
{
#if defined(HAVE_WINSERTLN) || defined(winsertln)
struct windata *winp;
GetWINDOW(obj, winp);
winsertln(winp->window);
#endif
return Qnil;
}
Inserts a line above the cursor, and the bottom line is lost
Source
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
}
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.
Source
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;
}
Return true if the specified line has been modified since the last call of refresh.
Source
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
}
A getter for the maximum columns for the window
Source
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
}
A getter for the maximum lines for the window
Source
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;
}
Moves the window so that the upper left-hand corner is at position (y, x)
Source
static VALUE
window_move_relative(VALUE obj, VALUE y, VALUE x)
{
struct windata *winp;
GetWINDOW(obj, winp);
mvderwin(winp->window, NUM2INT(y), NUM2INT(x));
return Qnil;
}
Moves the derived or subwindow inside its parent window. The screen-relative parameters of the window are not changed.
Source
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
}
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.
Source
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;
}
Refreshes the windows and lines.
Curses::Window.noutrefresh allows multiple updates with more efficiency than Curses::Window.refresh alone.
Source
static VALUE
window_redraw(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
redrawwin(winp->window);
return Qnil;
}
Redraws the entire window.
Source
static VALUE
window_refresh(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wrefresh(winp->window);
return Qnil;
}
Refreshes the windows and lines.
Source
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
}
Resize the current window to Fixnum lines and Fixnum cols
Source
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
}
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.
Source
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;
}
Scrolls the current window up one line.
Source
static VALUE
window_scrollok(VALUE obj, VALUE bf)
{
struct windata *winp;
GetWINDOW(obj, winp);
scrollok(winp->window, RTEST(bf) ? TRUE : FALSE);
return Qnil;
}
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)
Source
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;
}
A setter for the position of the cursor in the current window, using coordinates x and y
Source
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
}
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.
Source
static VALUE
window_standend(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wstandend(winp->window);
return Qnil;
}
Enables the Normal display (no highlight)
This is equivalent to Curses::Window.attron(A_NORMAL)
see also Curses::Window.attrset
Source
static VALUE
window_standout(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
wstandout(winp->window);
return Qnil;
}
Enables the best highlighting mode of the terminal.
This is equivalent to Curses::Window.attron(A_STANDOUT)
see also Curses::Window.attrset
Source
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, 0);
return win;
}
Construct a new subwindow with constraints of height lines, width columns, begin at top line, and begin left most column.
Source
static VALUE
window_timeout(VALUE obj, VALUE delay)
{
struct windata *winp;
GetWINDOW(obj,winp);
wtimeout(winp->window,NUM2INT(delay));
return Qnil;
}
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.
Source
static VALUE
window_touch(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
touchwin(winp->window);
return Qnil;
}
Treat the window as if it has been modified since the last call of refresh.
Source
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;
}
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.
Source
static VALUE
window_touched(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
return is_wintouched(winp->window) ? Qtrue : Qfalse;
}
Return true if the window has been modified since the last call of refresh.
Source
static VALUE
window_untouch(VALUE obj)
{
struct windata *winp;
GetWINDOW(obj, winp);
untouchwin(winp->window);
return Qnil;
}
Treat the window as if it has not been modified since the last call of refresh.