KeyEventProtocol

public protocol KeyEventProtocol : EventProtocol

The KeyEventProtocol protocol exposes the methods and properties of an underlying GdkKeyEvent instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see KeyEvent. Alternatively, use KeyEventRef as a lighweight, unowned reference if you already have an instance you just want to use.

An event related to a key-based device.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GdkKeyEvent instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • key_event_ptr Default implementation

    Typed pointer to the underlying GdkKeyEvent instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GdkKeyEvent instance.

    Declaration

    Swift

    var key_event_ptr: UnsafeMutablePointer<GdkKeyEvent>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to KeyEventProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

KeyEvent Class: KeyEventProtocol extension (methods and fields)

  • getConsumedModifiers() Extension method

    Extracts the consumed modifiers from a key event.

    Declaration

    Swift

    @inlinable
func getConsumedModifiers() -> ModifierType
    Show on GitHub
  • getKeycode() Extension method

    Extracts the keycode from a key event.

    Declaration

    Swift

    @inlinable
func getKeycode() -> Int
    Show on GitHub
  • getKeyval() Extension method

    Extracts the keyval from a key event.

    Declaration

    Swift

    @inlinable
func getKeyval() -> Int
    Show on GitHub
  • getLayout() Extension method

    Extracts the layout from a key event.

    Declaration

    Swift

    @inlinable
func getLayout() -> Int
    Show on GitHub
  • getLevel() Extension method

    Extracts the shift level from a key event.

    Declaration

    Swift

    @inlinable
func getLevel() -> Int
    Show on GitHub
  • getMatch(keyval:modifiers:) Extension method

    Gets a keyval and modifier combination that will match the event.

    See [methodGdk.KeyEvent.matches].

    Declaration

    Swift

    @inlinable
func getMatch(keyval: UnsafeMutablePointer<guint>!, modifiers: UnsafeMutablePointer<GdkModifierType>!) -> Bool
    Show on GitHub
  • matches(keyval:modifiers:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func matches(keyval: Int, modifiers: ModifierType) -> GdkKeyMatch
    Show on GitHub
  • consumedModifiers Extension method

    Extracts the consumed modifiers from a key event.

    Declaration

    Swift

    @inlinable
var consumedModifiers: ModifierType { get }
    Show on GitHub
  • isModifier Extension method

    Extracts whether the key event is for a modifier key.

    Declaration

    Swift

    @inlinable
var isModifier: Bool { get }
    Show on GitHub
  • keycode Extension method

    Extracts the keycode from a key event.

    Declaration

    Swift

    @inlinable
var keycode: Int { get }
    Show on GitHub
  • keyval Extension method

    Extracts the keyval from a key event.

    Declaration

    Swift

    @inlinable
var keyval: Int { get }
    Show on GitHub
  • layout Extension method

    Extracts the layout from a key event.

    Declaration

    Swift

    @inlinable
var layout: Int { get }
    Show on GitHub
  • level Extension method

    Extracts the shift level from a key event.

    Declaration

    Swift

    @inlinable
var level: Int { get }
    Show on GitHub