ExTermbox.Event (ExTermbox v2.0.4)

View Source

Represents an event received from the termbox library.

Events are polled by ExTermbox.Server and sent to the owner process.

Summary

Types

t()

The event structure.

Types

t()

@type t() :: %ExTermbox.Event{
  ch: integer() | nil,
  h: integer() | nil,
  key: atom() | integer() | nil,
  mod: atom() | integer() | nil,
  type: atom(),
  w: integer() | nil,
  x: integer() | nil,
  y: integer() | nil
}

The event structure.

Fields:

  • :type - The type of event (e.g., :key, :resize, :mouse). Atom.
  • :mod - Modifier keys pressed (e.g., :alt). Atom or nil.
  • :key - The key pressed (e.g., :f1, :arrow_up, :ctrl_a). Atom or nil.
  • :ch - The character pressed (if applicable, Unicode codepoint). Integer or nil.
  • :w - New width (for resize events). Integer or nil.
  • :h - New height (for resize events). Integer or nil.
  • :x - Mouse x position (for mouse events). Integer or nil.
  • :y - Mouse y position (for mouse events). Integer or nil.