Class: Vedeu::Input::Key

Inherits:

Object

• Object
• Vedeu::Input::Key

Defined in:

lib/vedeu/input/key.rb

Overview

A single keypress or combination of keypresses bound to a specific action.

Instance Attribute Summary

• #input ⇒ String|Symbol (also: #key) readonly

  Returns the key defined.

Instance Method Summary

• #initialize(input = nil, &block) ⇒ Vedeu::Input::Key constructor

  Returns a new instance of Vedeu::Input::Key.

• #output ⇒ |Symbol (also: #action, #press)

  Pressing the key will call the procedure.

Constructor Details

#initialize(input = nil, &block) ⇒ Vedeu::Input::Key

Returns a new instance of Vedeu::Input::Key.

Parameters:

• input (String|Symbol) (defaults to: nil)
• block (Proc)

Raises:

• (Vedeu::Error::RequiresBlock) —

  When the required block was not given.

# File 'lib/vedeu/input/key.rb', line 23

def initialize(input = nil, &block)
  raise Vedeu::Error::RequiresBlock unless block_given?

  @input  = input
  @output = block
end

Instance Attribute Details

#input ⇒ String|Symbol (readonly) Also known as: key

Returns the key defined.

Returns:

• (String|Symbol) —

  Returns the key defined.

# File 'lib/vedeu/input/key.rb', line 14

def input
  @input
end

Instance Method Details

#output ⇒ |Symbol Also known as: action, press

Pressing the key will call the procedure.

Returns:

• (|Symbol)

# File 'lib/vedeu/input/key.rb', line 33

def output
  @output.call
end