module

NCurses

Constants

BORDER_DEFAULT = 0.chr
ERR = -1

Possible integer result values

OK = 0
VERSION = "1.1.0"

Instance methods

add_char(*args, **options)

Output

Source
add_char(*args, **options, &)

Output

Source
assume_default_colors(fg, bg)
Source
attr_get(*args, **options)

Attribute

Source
attr_get(*args, **options, &)

Attribute

Source
attr_off(*args, **options)

Attribute

Source
attr_off(*args, **options, &)

Attribute

Source
attr_on(*args, **options)
Source
attr_on(*args, **options, &)
Source
attribute_off(*args, **options)

Attribute

Source
attribute_off(*args, **options, &)

Attribute

Source
attribute_on(*args, **options)
Source
attribute_on(*args, **options, &)
Source
border(*args, **options)

Output

Source
border(*args, **options, &)

Output

Source
box(*args, **options)

Output

Source
box(*args, **options, &)

Output

Source
can_change_color?

Terminal allows setting custom RGB color values Wrapper for can_change_color()

Source
cbreak

Disable buffering, key input is returned with no delay Wrapper for cbreak()

Source
change_attribute(*args, **options)
Source
change_attribute(*args, **options, &)
Source
change_background(*args, **options)

Background

Source
change_background(*args, **options, &)

Background

Source
change_color(slot, red, green, blue)

Alias for #init_color

Source
clear(*args, **options)
Source
clear(*args, **options, &)
Source
clear_to_bot(*args, **options)
Source
clear_to_bot(*args, **options, &)
Source
clear_to_eol(*args, **options)
Source
clear_to_eol(*args, **options, &)
Source
clearok(*args, **options)

Output options

Source
clearok(*args, **options, &)

Output options

Source
col(*args, **options)
Source
col(*args, **options, &)
Source
cols(*args, **options)

General

Source
cols(*args, **options, &)

General

Source
def_prog_mode

Save the tty mode

Source
disable_line_buffer

Alias for #cbreak

Source
draw_bvline(*args, **options)

Output

Source
draw_bvline(*args, **options, &)

Output

Source
draw_hline(*args, **options)

Output

Source
draw_hline(*args, **options, &)

Output

Source
echo(option : Bool)

If echoing back to terminal should be enabled

Source
echo

Re-enable echoing of input back to console Wrapper for echo()

Source
enable_line_buffer

Alias for #nocbreak

Source
end

End curses mode Wrapper for endwin()

Source
erase(*args, **options)
Source
erase(*args, **options, &)
Source
flush_input

Clear (delete contents of) the input buffer Wrapper for flushinp()

Source
get_attribute(*args, **options)

Attribute

Source
get_attribute(*args, **options, &)

Attribute

Source
get_background(*args, **options)

Background

Source
get_background(*args, **options, &)

Background

Source
get_char(*args, **options)
Source
get_char(*args, **options, &)
Source
get_mouse

Should only be called if #get_char returned Key::Mouse

Returns a MouseEvent containing the mouse state and coordinates Wrapper for getmouse()

Source
has_colors?

Terminal supports colors Wrapper for has_colors()

Source
has_mouse

If the terminal has mouse support Wrapper for has_mouse()

Source
height(*args, **options)

General

Source
height(*args, **options, &)

General

Source
idcok(*args, **options)

Output options

Source
idcok(*args, **options, &)

Output options

Source
idlok(*args, **options)

Output options

Source
idlok(*args, **options, &)

Output options

Source
immedok(*args, **options)

Output options

Source
immedok(*args, **options, &)

Output options

Source
init_color(slot, red, green, blue)

Change the RGB values of the color Between 0 and 1000

change_color Color::Red, 0, 0, 1000 # => Color::Red will now appear blue
Source
init_color_pair(slot, foreground : Color, background : Color)

Create a color pair to use Pass an integer for id of the pair in the slot Pass a Color for both the foreground and then background

init_color_pair 5, Color::Red, Color::Blue # => Color pair 5 is not red on black

Wrapper for init_pair()

Source
keypad(*args, **options)

Input

Source
keypad(*args, **options, &)

Input

Source
leaveok(*args, **options)

Output options

Source
leaveok(*args, **options, &)

Output options

Source
line_buffer(option)

If input should be buffered to new lines Enable if true, disable if false

Source
lines(*args, **options)

General

Source
lines(*args, **options, &)

General

Source
max_dimensions(*args, **options)
Source
max_dimensions(*args, **options, &)
Source
max_dimensions_named(*args, **options)
Source
max_dimensions_named(*args, **options, &)
Source
max_x(*args, **options)

General

Source
max_x(*args, **options, &)

General

Source
max_y(*args, **options)

General

Source
max_y(*args, **options, &)

General

Source
mouse_mask(new_mask : Mouse)

Sets the mouse events that should be returned Should be given a Mouse enum

Source
move(*args, **options)
Source
move(*args, **options, &)
Source
new_term(terminal, out_io, in_io)

Unknown functionality Wrpper for newterm()

Source
nl

Wrapper for nl()

Source
no_border(*args, **options)

Output

Source
no_border(*args, **options, &)

Output

Source
no_box(*args, **options)

Output

Source
no_box(*args, **options, &)

Output

Source
no_delay(*args, **options)

Input

Source
no_delay(*args, **options, &)

Input

Source
no_echo

Do not echo back to the console Wrapper for noecho()

Source
no_raw

Re-enable buffering of input and signals Wrapper for noraw()

Source
no_timeout(*args, **options)

Input

Source
no_timeout(*args, **options, &)

Input

Source
nocbreak

Re-enable buffering until new line Wrapper for nocbreak()

Source
nonl

Wrapper for nonl()

Source
pos(*args, **options)
Source
pos(*args, **options, &)
Source
pos_named(*args, **options)
Source
pos_named(*args, **options, &)
Source
position(*args, **options)
Source
position(*args, **options, &)
Source
position_named(*args, **options)
Source
position_named(*args, **options, &)
Source
print(*args, **options)

Output

Source
print(*args, **options, &)

Output

Source
raw(option)

If buffering should be disabled for input and signals

Source
raw

Disable buffering of input and signals #cbreak but also passes signals TODO: Implement signals?

Source
refresh(*args, **options)
Source
refresh(*args, **options, &)
Source
reset_prog_mode

Restore the tty mode

Source
row(*args, **options)
Source
row(*args, **options, &)
Source
scrollok(*args, **options)

Output options

Source
scrollok(*args, **options, &)

Output options

Source
set_attr(*args, **options)
Source
set_attr(*args, **options, &)
Source
set_attribute(*args, **options)
Source
set_attribute(*args, **options, &)
Source
set_background(*args, **options)

Background

Source
set_background(*args, **options, &)

Background

Source
set_color(*args, **options)

Attribute

Source
set_color(*args, **options, &)

Attribute

Source
set_cursor(visibility : Cursor)

Set the cursor state Use Cursor enum Wrapper for curs_set()

Source
set_pos(*args, **options)
Source
set_pos(*args, **options, &)
Source
setscrreg(*args, **options)

Output options

Source
setscrreg(*args, **options, &)

Output options

Source
start

Start curses mode Wrapper for initscr()

Source
start_color

Start color support Wrapper for start_color()

Source
stdscr

Get stdscr May remove due to delegateing

Source
term=(screen)

Unknown functionality Wrapper for set_term()

Source
timeout(*args, **options)

Input

Source
timeout(*args, **options, &)

Input

Source
use_default_colors
Source
width(*args, **options)

General

Source
width(*args, **options, &)

General

Source
with_attr(*args, **options)
Source
with_attr(*args, **options, &)
Source
with_attribute(*args, **options)
Source
with_attribute(*args, **options, &)
Source
x(*args, **options)
Source
x(*args, **options, &)
Source
y(*args, **options)
Source
y(*args, **options, &)
Source

Nested types