class: KeyEvent

[13:7] extends: object

An event related to a key-based device.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• KeyEvent (Handle = null)

  Creates a new KeyEvent by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asEvent ()

  Wraps this handle as Event.

  • @r A Event object.

• get_consumed_modifiers ()

  Extracts the consumed modifiers from a key event.

• get_keycode ()

  Extracts the keycode from a key event.

• get_keyval ()

  Extracts the keyval from a key event.

• get_layout ()

  Extracts the layout from a key event.

• get_level ()

  Extracts the shift level from a key event.

• is_modifier ()

  Extracts whether the key event is for a modifier key.

• matches (int keyval, string modifiers)

  Matches a key event against a keyval and modifiers. This is typically used to trigger keyboard shortcuts such as Ctrl-C. Partial matches are possible where the combination matches if the currently active group is ignored. Note that we ignore Caps Lock for matching.

  • @p keyval is the keyval to match.
  • @p modifiers is the modifiers to match.