Module: RatatuiRuby::Event::Key::System

Included in:
RatatuiRuby::Event::Key
Defined in:
lib/ratatui_ruby/event/key/system.rb

Overview

Methods and logic for system and function keys.

Instance Method Summary collapse

Instance Method Details

#function? ⇒ Boolean

Returns true if this is a function key (F1-F24).

event.function? # => true for f1, f2, ..., f24

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/ratatui_ruby/event/key/system.rb', line 25

def function?
  @kind == :function
end

#system? ⇒ Boolean

Returns true if this is a system key.

System keys include: Esc, CapsLock, ScrollLock, NumLock, PrintScreen, Pause, Menu, KeypadBegin.

event.system? # => true for pause, esc, caps_lock, etc.

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/ratatui_ruby/event/key/system.rb', line 18

def system?
  @kind == :system
end