ketraterm-input/io.github.ketraterm.input.event/TerminalMouseButton

TerminalMouseButton

enum TerminalMouseButton : Enum<TerminalMouseButton>

Platform-neutral mouse button vocabulary for terminal input reporting.

Entries

Primary pointer button.

Middle pointer button.

Secondary pointer button.

Wheel step upward.

Wheel step downward.

Wheel step leftward.

Wheel step rightward.

Used for motion events with no button pressed, especially ANY_EVENT tracking.

Properties

val entries: EnumEntries<TerminalMouseButton>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val name: String

val ordinal: Int

Functions

fun TerminalMouseButton.isWheel(): Boolean

Returns true when this button represents a wheel report.

fun valueOf(value: String): TerminalMouseButton

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<TerminalMouseButton>

Returns an array containing the constants of this enum type, in the order they're declared.