Teek API Documentation

Teek::UI::Keysyms Module

Translates the DSL’s Tk-free key vocabulary (friendly symbols, “Ctrl-x” style modifier strings) into real Tk bind event patterns. Its own small lookup, kept separate from Handle so it’s easy to extend.

Class Methods ↑

patterns_for(modifiers, keysym)

Tk event patterns to bind for a resolved [modifiers, keysym] pair - usually just one, but Shift+Tab is a known cross-platform gotcha: X11 delivers it as the distinct keysym ISO_Left_Tab, not Tab with a Shift modifier, so binding only silently never fires there. Bind every spelling so the handler fires regardless of platform; on platforms where a given spelling never occurs, that binding is simply inert.

Parameters
  • modifiers Array<String>
  • keysym String

Returns Array<String> — Tk bind event patterns, e.g. ["<Control-s>"]

View source ▼ 
def self.patterns_for(modifiers, keysym)
  if keysym == 'Tab' && modifiers.include?('Shift')
    without_shift = modifiers - ['Shift']
    [
      pattern(modifiers, 'Tab'),
      pattern(without_shift, 'ISO_Left_Tab'),
      pattern(modifiers, 'ISO_Left_Tab'),
    ].uniq
  else
    [pattern(modifiers, keysym)]
  end
end
GitHub

resolve(spec)

Parameters
  • spec Symbol, String — a friendly key (:enter) or a "Modifier-Modifier-Key" string ("Ctrl-Shift-s")

Returns Array(Array<String>, String) — [tk_modifiers, tk_keysym]

View source ▼ 
def self.resolve(spec)
  return [[], FRIENDLY.fetch(spec) { spec.to_s }] if spec.is_a?(Symbol)

  parts = spec.to_s.split('-')
  base = parts.pop
  keysym = FRIENDLY.fetch(base.downcase.to_sym) { base }
  modifiers = parts.map { |part| MODIFIER_ALIASES.fetch(part.downcase, part) }
  [modifiers, keysym]
end
GitHub