enum

Termisu::Event::Mouse::Button

Inherits Enum < Comparable < Value < Object

Mouse button types.

Constants

None = 0

No button (used for motion-only events).

Left = 1

Left mouse button (button 1).

Middle = 2

Middle mouse button (button 2).

Right = 3

Right mouse button (button 3).

WheelUp = 4

Scroll wheel up.

WheelDown = 5

Scroll wheel down.

WheelLeft = 6

Scroll wheel left (horizontal scroll).

WheelRight = 7

Scroll wheel right (horizontal scroll).

Release = 8

Button release event.

Button4 = 9

Extra button 4 (forward).

Button5 = 10

Extra button 5 (back).

Constructors

from_cb(cb : Int32) : Button

Decodes a button from the Cb value in mouse protocols.

Low 2 bits encode the button:

  • 0 = Left
  • 1 = Middle
  • 2 = Right
  • 3 = Release

Bit 6 (64) indicates wheel events:

  • 64 = Wheel Up
  • 65 = Wheel Down
  • 66 = Wheel Left
  • 67 = Wheel Right
Source

Instance methods

button4?

Returns true if this enum value equals Button4

Source
button5?

Returns true if this enum value equals Button5

Source
left?

Returns true if this enum value equals Left

Source
middle?

Returns true if this enum value equals Middle

Source
none?

Returns true if this enum value equals None

Source
release?

Returns true if this enum value equals Release

Source
right?

Returns true if this enum value equals Right

Source
wheel_down?

Returns true if this enum value equals WheelDown

Source
wheel_left?

Returns true if this enum value equals WheelLeft

Source
wheel_right?

Returns true if this enum value equals WheelRight

Source
wheel_up?

Returns true if this enum value equals WheelUp

Source