mordant/com.github.ajalt.mordant.input/InputReceiver

InputReceiver

interface InputReceiver<T>

An object that can receive input events.

Inheritors

InputReceiverAnimation

Types

sealed class Status<out T>

Properties

abstract val terminal: Terminal

The terminal that this receiver is reading input from.

Functions

abstract fun receiveEvent(event: InputEvent): InputReceiver.Status<T>

Receive an input event.

fun <T> InputReceiver<T>.receiveEvents(mouseTracking: MouseTracking = MouseTracking.Normal): T

Enter raw mode, read input from the terminal for this InputReceiver until it returns a result, then exit raw mode.