awsc.dashboard.Dashboard

class awsc.dashboard.Dashboard(*args, layout, **kwargs)

Dashboard controller class. The dashboard contains a number of dashboard blocks organized in a table.

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.

Methods

Autohotkey(key[, tooltip, is_validated, ...])	Decorator that automatically assigns a hotkey to a function upon instantiation.
add_block(block)	Adds a new child block to this block.
add_hotkey(hotkey, action[, tooltip, ...])	Adds a new hotkey to the control.
auto_refresh()	auto_refresh is called on top level blocks that have it automatically by the main loop.
autohotkey_condition(hotkey)	Autohotkey condition callback.
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.
configure_context_layout(*args)	Hotkey callback for configuring the context dashboard layout.
configure_default_layout(*args)	Hotkey callback for configuring the default dashboard layout.
force_refresh(*args)	Forcibly refreshes blocks.
input(key)	Input handler hook function.
load_layout(layout)	Reloads the dashboard with the layout configuration provided.
opener([layout])	Session-aware initializer for this class.
paint()	Hook function for painting the block.
register()	Registers everything related to dashboards.
reload_layout()	Callback for the configuration dialog to reload the dashboard.
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.
validate_hotkey(key)	Validates whether a hotkey can be used based on the state of the control.

on_become_frame

__init__(*args, layout, **kwargs)

Initializes a HotkeyControl object.

Methods

__init__(*args, layout, **kwargs)	Initializes a HotkeyControl object.
add_block(block)	Adds a new child block to this block.
add_hotkey(hotkey, action[, tooltip, ...])	Adds a new hotkey to the control.
auto_refresh()	auto_refresh is called on top level blocks that have it automatically by the main loop.
autohotkey_condition(hotkey)	Autohotkey condition callback.
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.
configure_context_layout(*args)	Hotkey callback for configuring the context dashboard layout.
configure_default_layout(*args)	Hotkey callback for configuring the default dashboard layout.
force_refresh(*args)	Forcibly refreshes blocks.
input(key)	Input handler hook function.
load_layout(layout)	Reloads the dashboard with the layout configuration provided.
on_become_frame()
opener([layout])	Session-aware initializer for this class.
paint()	Hook function for painting the block.
register()	Registers everything related to dashboards.
reload_layout()	Callback for the configuration dialog to reload the dashboard.
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.
validate_hotkey(key)	Validates whether a hotkey can be used based on the state of the control.

Attributes

block_registry
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.
prefix
title
w_in	Read-only property for the inner width of the block.
width	Read-only property for the width of the block.