class

NCurses::Window

Inherits Reference < Object

Constructors

new(window : LibNCurses::Window)
Source
new(height = nil, width = nil, y = 0, x = 0)

Create a new window with given size

Wrapper for newwin()

Source

Instance methods

add_char(chr, pos_y, pos_x)

Alias for #add_char

Source
add_char(chr, position = nil)

Draw a character

Wrapper for waddch() and mvwaddch() (addch() and mvaddch())

Source
attr_get

Get the current attributes and color pair as a named tuple with attr and color

Wrapper for wattr_get() (attr_get())

Source
attr_off(attr : Attribute)

Turn off attribute(s)

Wrapper for wattr_off() (attr_off())

Source
attr_on(attr : Attribute)

Turn on attribute(s)

Wrapper for wattr_on() (attr_on())

Source
attribute_off(attr : Attribute)

Alias for #attr_off

Source
attribute_on(attr : Attribute)

Alias for #attr_on

Source
change_attribute(attr : Attribute = Attribute::Normal, color_pair = 0, length = -1, y = nil, x = nil)

attr is the Attribute enum. color_pair is the color pair number (0 is the default white on black.) length defaults to -1, but represents the number of characters to change, up to EOL. If y and x are set, the cursor location is moved before changing attributes.

Wrapper for wchgat() and mvwchgat() (chgat() and mvchgat())

Source
change_background(char)

Change the background

Source
clear

Clear window

Wrapper for wclear() (clear())

Source
cols

Alias for #max_x

Source
delete_window

Delete the window

Wrapper for delwin()

Source
enclose?(y, x) : Bool

If a mouse position is in this window

Wrapper for wenclose()

Source
enclose?(yx : NamedTuple) : Bool
Source
enclose?(mouse_event : MouseEvent) : Bool

If a mouse event took place within this window

Source
enclose?(yx) : Bool
Source
get_attribute

Alias for #attr_get

Source
get_background

Get the character and attributes from the current background

Source
get_char

Get a character input

Returned as Key if recognised, Char otherwise

Wrapper for wgetch() (getch())

Source
get_char

Get a character input for main loop

Source
height

Alias for #max_y

Source
keypad(enable)

Enable or disable capturing function keys

Source
lines

Alias for #max_y

Source
max_dimensions

Max height and width as tuple (y,x)

Source
max_dimensions_named

Max height and width as named tuple

Source
max_x

Return width

Wrapper for getmaxx()

Source
max_y

Return height

Wrapper for getmaxy()

Source
move(y, x)

Move cursor to new position

Wrapper for wmove() (move())

Source
move(new_pos : Tuple)

Alias for #move

Source
move(new_pos : NamedTuple)

Alias for '#move'

Source
move_window(y, x)

Move window relative to whole screen

TODO: Tuple version

Wrapper for mvwin()

Source
no_delay

Do not wait for input, return ERR

Wrapper for nodelay()

Source
no_timeout

Wait for input, no errors should be returned

Wrapper for notimeout()

Source
non_relative(event : MouseEvent) : MouseEvent
Source
print(message, pos_y, pos_x)

Alias for #print

Source
print(message, position = nil)

Write a string

Wrapper for wprintw() and mvwprintw() (printw() and mvprintw())

Source
refresh

Refresh window

Wrapper for wrefresh() (refresh())

Source
relative(event : MouseEvent) : MouseEvent

Returns a new MouseEvent with coordinates relative to the window

To convert back user #non_relative

Source
set_attr(attr : Attribute = Attribute::Normal, color_pair = 0)

Replace attribute(s) and color with these

Wrapper for wattr_set() (attr_set())

Source
set_attribute(attr : Attribute = Attribute::Normal, color_pair = 0)

Alias for #set_attr

Source
set_background(char)

Sets a new background and applies it everywhere

Source
set_color(color_pair = 0)

Set this window's default color pair

Wrapper for wcolor_set() (color_set())

Source
set_pos(y, x)

Alias for #move

Source
set_pos(new_pos : Tuple)

Alias for #move

Source
set_pos(new_pos : NamedTuple)

Alias for '#move'

Source
timeout=(value)

Set input timeout

Wrapper for wtimeout() (timeout())

Source
to_unsafe
Source
width

Alias for #max_x

Source
with_attr(attrs : Attribute, &)

Block with attribute(s) turned on

Source
with_attribute(attrs : Attribute, &)

Alias for #with_attr

Source