awsc.info.InfoDisplay

class awsc.info.InfoDisplay(*args, info=None, cols=2, highlight_color=None, generic_color=None, **kwargs)

The info display is the control situated in the top left corner of the screen. It is intended to display information on the active session as a list of key-value pairs. The info display also registers the global hotkeys.

Attributes:

infodict

The actual info being displayed, as a mapping of label to data.

orderlist

The order in which the info should be displayed.

special_colorsdict

A mapping of label to color for which pieces of data should be highlighted with a non-standard color, for example, for use with errors.

colsint

The number of info columns to divide the available space to.

highlight_colorawsc.termui.color.Color

The color of the label.

generic_colorawsc.termui.color.Color

The default color of data.

commander_hookcallable

The callback to call for opening the commander.

filterer_hookcallable

The callback to call for opening the filterer.

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, info=None, cols=2, highlight_color=None, generic_color=None, **kwargs)

Initializes a Control object.

Parameters:

borderawsc.termui.control.Border

The border of the control.

Methods

__init__(*args[, info, cols, ...])	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.