Class: Fatty::MouseEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/fatty/mouse_event.rb

Overview

The MouseEvent class is a simple class to store a mouse event with its modifiers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(button:, x: nil, y:, raw: nil, ctrl: false, meta: false, shift: false) ⇒ MouseEvent

Returns a new instance of MouseEvent.



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/fatty/mouse_event.rb', line 9

def initialize(button:, x: nil, y:, raw: nil, ctrl: false, meta: false, shift: false)
  @button = button
  @x = x
  @y = y
  @raw = raw
  @ctrl = ctrl
  @meta = meta
  @shift = shift
  Fatty.debug("#{self.class}#new(#{self})", tag: :event)
end

Instance Attribute Details

#button ⇒ Object (readonly)

Returns the value of attribute button.



7
8
9
 
# File 'lib/fatty/mouse_event.rb', line 7

def button
  @button
end

#ctrl ⇒ Object (readonly)

Returns the value of attribute ctrl.



7
8
9
 
# File 'lib/fatty/mouse_event.rb', line 7

def ctrl
  @ctrl
end

#meta ⇒ Object (readonly)

Returns the value of attribute meta.



7
8
9
 
# File 'lib/fatty/mouse_event.rb', line 7

def meta
  @meta
end

#raw ⇒ Object (readonly)

Returns the value of attribute raw.



7
8
9
 
# File 'lib/fatty/mouse_event.rb', line 7

def raw
  @raw
end

#shift ⇒ Object (readonly)

Returns the value of attribute shift.



7
8
9
 
# File 'lib/fatty/mouse_event.rb', line 7

def shift
  @shift
end

#x ⇒ Object (readonly)

Returns the value of attribute x.



7
8
9
 
# File 'lib/fatty/mouse_event.rb', line 7

def x
  @x
end

#y ⇒ Object (readonly)

Returns the value of attribute y.



7
8
9
 
# File 'lib/fatty/mouse_event.rb', line 7

def y
  @y
end

Instance Method Details

#mouse? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/fatty/mouse_event.rb', line 28

def mouse?
  true
end

#printable? ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/fatty/mouse_event.rb', line 24

def printable?
  false
end

#to_s ⇒ Object 



20
21
22
 
# File 'lib/fatty/mouse_event.rb', line 20

def to_s
  "MouseEvent: button: `#{button}`, x: `#{x}`, y: `#{y}`, raw: `#{raw}`, ctrl: `#{ctrl}`, meta: `#{meta}`, shift: `#{shift}`"
end