ModifierType

public struct ModifierType : OptionSet

A set of bit-flags to indicate the state of modifier keys and mouse buttons in various event types. Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.

Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped to Mod2 - Mod5, and indicates this by setting GDK_SUPER_MASK, GDK_HYPER_MASK or GDK_META_MASK in the state field of key events.

Note that GDK may add internal values to events which include reserved values such as GDK_MODIFIER_RESERVED_13_MASK. Your code should preserve and ignore them. You can use GDK_MODIFIER_MASK to remove all reserved values.

Also note that the GDK X backend interprets button press events for button 4-7 as scroll events, so GDK_BUTTON4_MASK and GDK_BUTTON5_MASK will never be set.

Show on GitHub

  • The corresponding value of the raw type

    Declaration

    Swift

    public var rawValue: UInt32
    Show on GitHub

  • The equivalent raw Int value

    Declaration

    Swift

    @inlinable
public var intValue: Int { get set }
    Show on GitHub
  • int

    The equivalent raw gint value

    Declaration

    Swift

    @inlinable
public var int: gint { get set }
    Show on GitHub

  • The equivalent underlying GdkModifierType enum value

    Declaration

    Swift

    @inlinable
public var value: GdkModifierType { get set }
    Show on GitHub

  • Creates a new instance with the specified raw value

    Declaration

    Swift

    @inlinable
public init(rawValue: UInt32)
    Show on GitHub

  • Creates a new instance with the specified GdkModifierType enum value

    Declaration

    Swift

    @inlinable
public init(_ enumValue: GdkModifierType)
    Show on GitHub

  • Creates a new instance with the specified Int value

    Declaration

    Swift

    @inlinable
public init<I>(_ intValue: I) where I : BinaryInteger
    Show on GitHub

  • the Shift key.

    Declaration

    Swift

    public static let shiftMask: ModifierType
    Show on GitHub

  • a Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock).

    Declaration

    Swift

    public static let lockMask: ModifierType
    Show on GitHub

  • the Control key.

    Declaration

    Swift

    public static let controlMask: ModifierType
    Show on GitHub

  • the fourth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier, but normally it is the Alt key).

    Declaration

    Swift

    public static let mod1Mask: ModifierType
    Show on GitHub

  • the fifth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

    Declaration

    Swift

    public static let mod2Mask: ModifierType
    Show on GitHub

  • the sixth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

    Declaration

    Swift

    public static let mod3Mask: ModifierType
    Show on GitHub

  • the seventh modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

    Declaration

    Swift

    public static let mod4Mask: ModifierType
    Show on GitHub

  • the eighth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

    Declaration

    Swift

    public static let mod5Mask: ModifierType
    Show on GitHub

  • the first mouse button.

    Declaration

    Swift

    public static let button1Mask: ModifierType
    Show on GitHub

  • the second mouse button.

    Declaration

    Swift

    public static let button2Mask: ModifierType
    Show on GitHub

  • the third mouse button.

    Declaration

    Swift

    public static let button3Mask: ModifierType
    Show on GitHub

  • the fourth mouse button.

    Declaration

    Swift

    public static let button4Mask: ModifierType
    Show on GitHub

  • the fifth mouse button.

    Declaration

    Swift

    public static let button5Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved13Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved14Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved15Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved16Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved17Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved18Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved19Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved20Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved21Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved22Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved23Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved24Mask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved25Mask: ModifierType
    Show on GitHub

  • the Super modifier. Since 2.10

    Declaration

    Swift

    public static let superMask: ModifierType
    Show on GitHub

  • the Hyper modifier. Since 2.10

    Declaration

    Swift

    public static let hyperMask: ModifierType
    Show on GitHub

  • the Meta modifier. Since 2.10

    Declaration

    Swift

    public static let metaMask: ModifierType
    Show on GitHub

  • A reserved bit flag; do not use in your own code

    Declaration

    Swift

    public static let modifierReserved29Mask: ModifierType
    Show on GitHub

  • not used in GDK itself. GTK+ uses it to differentiate between (keyval, modifiers) pairs from key press and release events.

    Declaration

    Swift

    public static let releaseMask: ModifierType
    Show on GitHub

  • a mask covering all modifier types.

    Declaration

    Swift

    public static let modifierMask: ModifierType
    Show on GitHub