GLXCurses.Aera module¶

class GLXCurses.Aera.Area(x=None, y=None, width=None, height=None, screen=None, subwin=None)[source]¶

Bases: object

Internal class it define a Area

Note

it never have a clamp value or a float to int conversion, each set method have role to raise a error if value type is not respect during a set.

x¶

x property

It represent the x location, 0 for Left

Returns:	`x` location in char, 0 correspond to left
Return type:	int or None

y¶

y location of the area

Returns:	`y` location in char, 0 correspond to top
Return type:	int

width¶

Get width property value.

Returns:	`width` property
Return type:	int or None

height¶

Get height property value.

Returns:	`height` property
Return type:	int or None

stdscr¶

Get the stdscr property value.

Returns:	A Curses window object`
Return type:	_curses.curses window or None

subwin¶

Get the subwin property value.

Returns:	A Curses window object`
Return type:	_curses.curses window or None

add_character(y=None, x=None, character=None, color=None)[source]¶

insert_character(y=None, x=None, character=None, color=None)[source]¶

add_horizontal_line(y=None, x=None, character=None, length=None, color=None)[source]¶: Display a horizontal line starting at (y, x) with length n consisting of the character character.

add_vertical_line(y=None, x=None, character=None, length=None, color=None)[source]¶: Display a horizontal line starting at (y, x) with length n consisting of the character character.

add_rectangle(uly, ulx, lry, lrx)[source]¶: Draw a rectangle with corners at the provided upper-left and lower-right coordinates.