runtimepy.tui.channels package

Contents

runtimepy.tui.channels package#

Module contents#

A module implementing a channel-environment user interface.

class runtimepy.tui.channels.ChannelTui(env: ChannelEnvironment)[source]#

Bases: TuiMixin

A class for implementing a text user-interface for channel environments.

property body: Any#: Get this interface’s body window.

async dispatch() → bool[source]#: Dispatch this user interface.

async handle_char(char: int) → bool[source]#: Handle character input.

property header: Any#: Get this interface’s header window.

init(window: Any) → bool[source]#: Initialize this interface’s window.

async update_body() → None[source]#: Update the body portion of the interface.

update_dimensions() → Any[source]#: Handle an update to the window’s dimensions.

async update_header() → None[source]#: Update the header portion of the interface.

runtimepy.tui.channels.CursesWindow#: alias of Any

class runtimepy.tui.channels.TuiMixin(window: Any | None = None)[source]#

Bases: object

A class mixin for building TUI applications.

cursor: Cursor#

async handle_char(char: int) → bool[source]#: Handle character input.

init(window: Any | None) → bool[source]#: Initialize this interface’s window.

tui_update() → None[source]#: Re-draw the screen.

update_dimensions() → Any[source]#: Handle an update to the window’s dimensions.

property window: Any#: Get the window for this instance.