Module: RETerm::NavControls

Included in:
NavInput
Defined in:
lib/reterm/mixins/nav_controls.rb

Constant Summary collapse

QUIT_CONTROLS =

Key which if pressed causes the navigation component to lose focus / become deactivated

[27]
ENTER_CONTROLS =

Key if pressed focuses on / activates a component

[10, Ncurses::KEY_ENTER]
UP_CONTROLS =

Up navigation keys

['k'.ord, 'K'.ord, Ncurses::KEY_UP]
DOWN_CONTROLS =

Down navigation keys

['j'.ord, 'J'.ord, Ncurses::KEY_DOWN]
LEFT_CONTROLS =

Left navigation keys

['h'.ord, 'H'.ord, Ncurses::KEY_BACKSPACE,
Ncurses::KEY_BTAB,
Ncurses::KEY_LEFT]
RIGHT_CONTROLS =

Right navigation keys

['l'.ord, 'L'.ord, "\t".ord, Ncurses::KEY_RIGHT]
MOVEMENT_CONTROLS =

All movement keys

UP_CONTROLS   + DOWN_CONTROLS +
LEFT_CONTROLS + RIGHT_CONTROLS

Instance Method Summary collapse

Instance Method Details

#quit_nav?(ch = nil) ⇒ Boolean

Quit when quit-sequence detected or app-shutdown

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/reterm/mixins/nav_controls.rb', line 29

def quit_nav?(ch=nil)
  (!ch.nil? && QUIT_CONTROLS.include?(ch) || shutdown? || deactivate?)
end