enum Termisu::Input::Modifier

Overview

Keyboard modifier flags for input events.

Modifiers can be combined using bitwise OR (|). XTerm encodes modifiers as: code = 1 + (shift1 + alt2 + ctrl4 + meta8)

Example:

event = termisu.poll_event
if event.is_a?(Termisu::Event::Key)
  if event.modifiers.ctrl? && event.key.lower_c?
    puts "Ctrl+C pressed!"
  end
end

Defined in:

termisu/input/modifier.cr

Enum Members

None = 0_u8

No modifiers

Shift = 1_u8

Shift key

Alt = 2_u8

Alt/Option key

Ctrl = 4_u8

Control key

Meta = 8_u8

Meta/Super/Windows key

All = 15_u8

Constructors

• .from_mouse_cb(cb : Int32) : Modifier

  Decodes mouse button modifiers from the Cb byte.

• .from_xterm_code(code : Int32) : Modifier

  Decodes an XTerm modifier code to Modifier flags.

Instance Method Summary

• #alt?

  Returns true if this enum value contains Alt

• #ctrl?

  Returns true if this enum value contains Ctrl

• #meta?

  Returns true if this enum value contains Meta

• #none?

  Returns true if this enum value contains None

• #shift?

  Returns true if this enum value contains Shift

Constructor Detail

Instance Method Detail