class NCurses::Window
- NCurses::Window
- Reference
- Object
Defined in:
ncurses.crncurses/window.cr
Constructors
- .new(window : LibNCurses::Window)
-
.new(height = nil, width = nil, y = 0, x = 0)
Create a new window with given size
Instance Method Summary
-
#add_char(chr, pos_y, pos_x)
Alias for
#add_char
-
#add_char(chr, position = nil)
Draw a character
-
#attr_get
Get the current attributes and color pair as a named tuple with attr and color
-
#attr_off(attr : Attribute)
Turn off attribute(s)
-
#attr_on(attr : Attribute)
Turn on attribute(s)
-
#attribute_off(attr : Attribute)
Alias for
#attr_off
-
#attribute_on(attr : Attribute)
Alias for
#attr_on
-
#change_attribute(attr : Attribute = Attribute::Normal, color_pair = 0, length = -1, y = nil, x = nil)
attr is the
Attribute
enum. -
#change_background(char)
Change the background
-
#clear
Clear window
-
#cols
Alias for
#max_x
-
#delete_window
Delete the window
-
#enclose?(y, x) : Bool
If a mouse position is in this window
- #enclose?(yx : NamedTuple) : Bool
-
#enclose?(mouse_event : MouseEvent) : Bool
If a mouse event took place within this window
- #enclose?(yx) : Bool
-
#get_attribute
Alias for
#attr_get
-
#get_background
Get the character and attributes from the current background
-
#get_char : Key | Char | Nil
Get a character input
-
#get_char(&)
Get a character input for main loop
-
#height
Alias for
#max_y
-
#keypad(enable)
Enable or disable capturing function keys
-
#lines
Alias for
#max_y
-
#max_dimensions
Max height and width as tuple (y,x)
-
#max_dimensions_named
Max height and width as named tuple
-
#max_x
Return width
-
#max_y
Return height
-
#move(y, x)
Move cursor to new position
-
#move(new_pos : Tuple)
Alias for
#move
-
#move(new_pos : NamedTuple)
Alias for '#move'
-
#move_window(y, x)
Move window relative to whole screen
-
#no_delay
Do not wait for input, return ERR
-
#no_timeout
Wait for input, no errors should be returned
- #non_relative(event : MouseEvent) : MouseEvent
-
#print(message, pos_y, pos_x)
Alias for
#print
-
#print(message, position = nil)
Write a string
-
#refresh
Refresh window
-
#relative(event : MouseEvent) : MouseEvent
Returns a new
MouseEvent
with coordinates relative to the window -
#set_attr(attr : Attribute = Attribute::Normal, color_pair = 0)
Replace attribute(s) and color with these
-
#set_attribute(attr : Attribute = Attribute::Normal, color_pair = 0)
Alias for
#set_attr
-
#set_background(char)
Sets a new background and applies it everywhere
-
#set_color(color_pair = 0)
Set this window's default color pair
-
#set_pos(y, x)
Alias for
#move
-
#set_pos(new_pos : Tuple)
Alias for
#move
-
#set_pos(new_pos : NamedTuple)
Alias for '#move'
-
#timeout=(value)
Set input timeout
- #to_unsafe : LibNCurses::Window
-
#width
Alias for
#max_x
-
#with_attr(attrs : Attribute, &)
Block with attribute(s) turned on
-
#with_attribute(attrs : Attribute, &)
Alias for
#with_attr
Constructor Detail
Create a new window with given size
Wrapper for newwin()
Instance Method Detail
Draw a character
Wrapper for waddch()
and mvwaddch()
(addch()
and mvaddch()
)
Get the current attributes and color pair as a named tuple with attr and color
Wrapper for wattr_get()
(#attr_get()
)
Turn off attribute(s)
Wrapper for wattr_off()
(#attr_off()
)
Turn on attribute(s)
Wrapper for wattr_on()
(#attr_on()
)
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()
)
Write a string
Wrapper for wprintw()
and mvwprintw()
(printw()
and mvprintw()
)
Returns a new MouseEvent
with coordinates relative to the window
To convert back user #non_relative
Replace attribute(s) and color with these
Wrapper for wattr_set()
(attr_set()
)
Alias for #set_attr
Set this window's default color pair
Wrapper for wcolor_set()
(color_set()
)