ConnectBot Terminal/org.connectbot.terminal

Package-level declarations

Types

ComposeController

interface ComposeController

Public API interface for controlling compose mode in the terminal.

DelKeyMode

sealed class DelKeyMode

Controls what byte sequence the backspace key sends.

InlineImageLimits

data class InlineImageLimits(val encodedBytes: Int = 16 * 1024 * 1024, val decodedBytes: Int = 32 * 1024 * 1024, val transferBytes: Int = 4 * 1024 * 1024, val uploadBytes: Int = 16 * 1024 * 1024, val maxDimension: Int, val maxPixels: Int = 16 * 1024 * 1024, val maxImages: Int = 1024, val maxPlacements: Int = 4096, val maxFrames: Int = 4096)

Per-terminal limits. Budgets include retained data and reservations for pending work.

InlineImageProtocolType

enum InlineImageProtocolType : Enum<InlineImageProtocolType>

InlineImageRequest

data class InlineImageRequest(val protocol: InlineImageProtocolType, val action: String, val imageId: Long? = null, val imageNumber: Long? = null, val name: String? = null, val declaredSizeBytes: Long? = null, val pixelWidth: Int? = null, val pixelHeight: Int? = null)

Header metadata available before any image payload is decoded.

InlineImages

sealed class InlineImages

Controls whether inline-image protocol payloads are accepted.

ModifierManager

interface ModifierManager

Manages modifier key state for terminal keyboard input. This can be used to combine some external state about the Ctrl, Alt, and Shift keys. For instance, combining a keyboard with an on-screen button.

ProgressState

enum ProgressState : Enum<ProgressState>

Progress state for OSC 9;4 progress reporting. Used by Windows Terminal and other terminals to display progress in tab headers.

RightAltMode

sealed class RightAltMode

Controls how the right-alt key (AltGr) is interpreted by the terminal keyboard handler.

SelectionController

interface SelectionController

Interface for controlling text selection in the terminal. This allows external components (UI chrome, keyboard handlers, accessibility) to control selection.

SelectionMode

sealed class SelectionMode

TerminalDimensions

data class TerminalDimensions(val rows: Int, val columns: Int, val widthPixels: Int, val heightPixels: Int)

Represents the terminal's character grid and physical viewport.

TerminalEmulator

sealed interface TerminalEmulator

Terminal emulator interface. This has no dependency on any UI framework so it may be run in a Service on Android. It handles the management of the terminal emulation state.

TerminalEmulatorFactory

class TerminalEmulatorFactory

TerminalUrl

data class TerminalUrl(val url: String, val source: TerminalUrlSource)

URL discovered in terminal output.

TerminalUrlSource

sealed class TerminalUrlSource

UrlScanScope

sealed class UrlScanScope

Line range to scan for URLs.

VTermKey

object VTermKey

VTerm key codes from libvterm. These correspond to VTermKey enum in vterm.h

Functions

Terminal

@Composable

fun Terminal(terminalEmulator: TerminalEmulator, modifier: Modifier = Modifier, typeface: Typeface = Typeface.MONOSPACE, initialFontSize: TextUnit = 11.sp, minFontSize: TextUnit = 6.sp, maxFontSize: TextUnit = 30.sp, backgroundColor: Color = Color.Black, foregroundColor: Color = Color.White, selectionBackgroundColor: Color = Color(0xFFB3D7FF), selectionForegroundColor: Color = Color.Black, keyboardEnabled: Boolean = false, showSoftKeyboard: Boolean = true, focusRequester: FocusRequester = remember { FocusRequester() }, onTerminalTap: () -> Unit = {}, onImeVisibilityChanged: (Boolean) -> Unit = {}, forcedSize: Pair<Int, Int>? = null, modifierManager: ModifierManager? = null, onSelectionControllerAvailable: (SelectionController) -> Unit? = null, onHyperlinkClick: (String) -> Unit = {}, onComposeControllerAvailable: (ComposeController) -> Unit? = null, onPasteRequest: () -> Unit? = null, rightAltMode: RightAltMode = RightAltMode.CharacterModifier, delKeyMode: DelKeyMode = DelKeyMode.Delete, onInterceptKey: (KeyEvent) -> Boolean? = null)

Terminal - A Jetpack Compose terminal screen component.