awsc.termui.control.Control

class awsc.termui.control.Control(*args, border=None, **kwargs)

The base object for all controllable blocks.

Attributes:

_borderawsc.termui.control.Border

The border of the control.

thread_sharedict

A cross-thread storage for update threads to share data with the main execution thread.

mutexthreading.Lock

A mutex used to lock the cross-thread storage.

Methods

add_block(block)	Adds a new child block to this block.
before_paint()	Hook function for acting on the block before any blocks are painted for the current frame.
bottomright()	Returns the coordinates of the bottom right corner of the block.
clear_blocks([tag])	Removes all blocks with the matching tag from the child blocks of this block.
input(key)	Input handler hook function.
paint()	Hook function for painting the block.
remove_block(block)	Removes a specific block from this block.
reparent()	Shorthand function for removing a Block from its parent and re-adding it.
topleft()	Returns the coordinates of the top left corner of the block.

on_become_frame

__init__(*args, border=None, **kwargs)

Initializes a Control object.

Parameters:

borderawsc.termui.control.Border

The border of the control.

Methods

__init__(*args[, border])	Initializes a Control object.
add_block(block)	Adds a new child block to this block.
before_paint()	Hook function for acting on the block before any blocks are painted for the current frame.
bottomright()	Returns the coordinates of the bottom right corner of the block.
clear_blocks([tag])	Removes all blocks with the matching tag from the child blocks of this block.
input(key)	Input handler hook function.
on_become_frame()
paint()	Hook function for painting the block.
remove_block(block)	Removes a specific block from this block.
reparent()	Shorthand function for removing a Block from its parent and re-adding it.
topleft()	Returns the coordinates of the top left corner of the block.

Attributes

border	Returns the border of the control.
corners	Read-only property for calculating the four corners of the block.
height	Read-only property for the height of the block.
inner	Read-only property for calculating the four inner corners of the block.
w_in	Read-only property for the inner width of the block.
width	Read-only property for the width of the block.