KetraTerm
API · DevelopmentAll versions

TerminalMouseEvent

data class TerminalMouseEvent(val column: Int, val row: Int, val button: TerminalMouseButton, val type: TerminalMouseEventType, val modifiers: Int = TerminalModifiers.NONE, val pixelX: Int = -1, val pixelY: Int = -1) : TerminalInputEvent

One platform-neutral mouse event accepted by the terminal input encoder.

Coordinates are zero-based grid cell coordinates. The encoder converts them to the terminal protocol's one-based coordinates at the wire boundary.

Constructors

Link copied to clipboard
constructor(column: Int, row: Int, button: TerminalMouseButton, type: TerminalMouseEventType, modifiers: Int = TerminalModifiers.NONE, pixelX: Int = -1, pixelY: Int = -1)

Properties

Link copied to clipboard

button or wheel direction associated with this event.

Link copied to clipboard
val column: Int

zero-based cell column.

Link copied to clipboard

active keyboard modifiers using TerminalModifiers bits.

Link copied to clipboard
val pixelX: Int

zero-based pixel column; -1 uses column for SGR-Pixels.

Link copied to clipboard
val pixelY: Int

zero-based pixel row; -1 uses row for SGR-Pixels.

Link copied to clipboard
val row: Int

zero-based cell row.

Link copied to clipboard

mouse event family.