enum Termisu::Event::MouseButton

Overview

Mouse button types.

Defined in:

termisu/event/mouse.cr

Enum Members

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

Instance Method Summary

Constructor Detail

def self.from_cb(cb : Int32) : MouseButton #

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

[View source]

Instance Method Detail

def button4? #

Returns true if this enum value equals Button4


[View source]
def button5? #

Returns true if this enum value equals Button5


[View source]
def left? #

Returns true if this enum value equals Left


[View source]
def middle? #

Returns true if this enum value equals Middle


[View source]
def none? #

Returns true if this enum value equals None


[View source]
def release? #

Returns true if this enum value equals Release


[View source]
def right? #

Returns true if this enum value equals Right


[View source]
def wheel_down? #

Returns true if this enum value equals WheelDown


[View source]
def wheel_left? #

Returns true if this enum value equals WheelLeft


[View source]
def wheel_right? #

Returns true if this enum value equals WheelRight


[View source]
def wheel_up? #

Returns true if this enum value equals WheelUp


[View source]