Module: Umbra::KeyMappingHandler

Included in:
Form, Widget
Defined in:
lib/umbra/keymappinghandler.rb

Instance Method Summary collapse

Instance Method Details

#_process_key(keycode, object, window) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/umbra/keymappinghandler.rb', line 74

def _process_key keycode, object, window
  return :UNHANDLED if @_key_map.nil?
  blk = @_key_map[keycode]
  #$log.debug "XXX:  _process key keycode #{keycode} #{blk.class}, #{self.class} "
  return :UNHANDLED if blk.nil?

  if blk.is_a? Symbol
    if respond_to? blk
      return send(blk, *@_key_args[keycode])
    else
      ## 2013-03-05 - 19:50 why the hell is there an alert here, nowhere else
      $log.error "This ( #{self.class} ) does not respond to #{blk.to_s} [PROCESS-KEY]" if $log
      # added 2013-03-05 - 19:50 so called can know
      return :UNHANDLED 
    end
  else
    #$log.debug "rwidget BLOCK called _process_key " if $log.debug? 
    return blk.call object,  *@_key_args[keycode]
  end
end

#bind_key(keycode, *args, &blk) ⇒ Object

bind a method to a key. – call cursor_home on pressing C-a. The symbol will also act as documentation for the key bind_key ?C-a, :cursor_home – call collapse_parent on pressing x. The string will be the documentation for the key bind_key(?x, ‘collapse parent’){ collapse_parent() }



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/umbra/keymappinghandler.rb', line 21

def bind_key keycode, *args, &blk
  #$log.debug " #{@name} bind_key received #{keycode} "
  @_key_map ||= {}
  #
  # added on 2011-12-4 so we can pass a description for a key and print it
  # The first argument may be a string, it will not be removed
  # so existing programs will remain as is.
  @key_label ||= {}
  if args[0].is_a?(String) || args[0].is_a?(Symbol)
    @key_label[keycode] = args[0] 
  else
    @key_label[keycode] = :unknown
  end

  if !block_given?
    blk = args.pop
    raise "If block not passed, last arg should be a method symbol" if !blk.is_a? Symbol
    #$log.debug " #{@name} bind_key received a symbol #{blk} "
  end
  case keycode
  when String
    # single assignment
    keycode = keycode.getbyte(0) 
  when Array
    # 2018-03-10 - unused now delete
    raise "unused"
  else
    #$log.debug " assigning #{keycode} to  _key_map for #{self.class}, #{@name}" if $log.debug? 
  end
  @_key_map[keycode] = blk
  @_key_args ||= {}
  @_key_args[keycode] = args
  self
end

#bind_keys(keycodes, *args, &blk) ⇒ Object 



56
57
58
 
# File 'lib/umbra/keymappinghandler.rb', line 56

def bind_keys keycodes, *args, &blk
  keycodes.each { |k| bind_key k, *args, &blk }
end

#process_key(keycode, object) ⇒ Object

e.g. process_key ch, self returns UNHANDLED if no block for it after form handles basic keys, it gives unhandled key to current field, if current field returns unhandled, then it checks this map.



70
71
72
 
# File 'lib/umbra/keymappinghandler.rb', line 70

def process_key keycode, object
  return _process_key keycode, object, @graphic
end

#unbind_key(keycode) ⇒ Object

remove a binding that you don’t want



61
62
63
64
 
# File 'lib/umbra/keymappinghandler.rb', line 61

def unbind_key keycode
  @_key_args.delete keycode unless @_key_args.nil?
  @_key_map.delete keycode unless @_key_map.nil?
end