struct

Termisu::Event::Mouse

Inherits Struct / Value / Object

Mouse input event.

Contains mouse position, button state, and modifiers. Supports all mouse protocols (X10, Normal, SGR, URXVT).

Example:

event = termisu.poll_event
if event.is_a?(Termisu::Event::Mouse)
  case event.button
  when .left?
    puts &quot;Left click at #{event.x},#{event.y}&quot;
  when .wheel_up?
    puts &quot;Scroll up&quot;
  when .release?
    puts &quot;Button released&quot;
  end
end

Constructors

new(x : Int32, y : Int32, button : Button, modifiers : Input::Modifier = Input::Modifier::None, motion : Bool = false)

Instance methods

alt?

Returns true if Alt modifier was held.

button

Mouse button that triggered the event.

ctrl?

Returns true if Ctrl modifier was held.

meta?

Returns true if Meta/Super/Windows modifier was held.

modifiers

Modifier keys held during the mouse event.

motion?

Whether this is a motion event (mouse moved while button held).

press?

Returns true if this is a button press event.

shift?

Returns true if Shift modifier was held.

wheel?

Returns true if this is a wheel scroll event.

x

X coordinate (column, 1-based).

y

Y coordinate (row, 1-based).

Nested types