Event

open class Event : EventProtocol

The Event type acts as an owner of an underlying GdkEvent instance. It provides the methods that can operate on this data type through EventProtocol conformance. Use Event as a strong reference or owner of a GdkEvent instance.

A GdkEvent contains a union of all of the event types, and allows access to the data fields in a number of ways.

The event type is always the first field in all of the event types, and can always be accessed with the following code, no matter what type of event it is: (C Language Example):

  GdkEvent *event;
  GdkEventType type;

  type = event->type;

To access other fields of the event, the pointer to the event can be cast to the appropriate event type, or the union member name can be used. For example if the event type is GDK_BUTTON_PRESS then the x coordinate of the button press can be accessed with: (C Language Example):

  GdkEvent *event;
  gdouble x;

  x = ((GdkEventButton*)event)->x;

or: (C Language Example):

  GdkEvent *event;
  gdouble x;

  x = event->button.x;
Show on GitHub
  • ptr 
    Untyped pointer to the underlying `GdkEvent` instance.

    For type-safe access, use the generated, typed pointer event_ptr property instead.

    Declaration

    Swift

    public let ptr: UnsafeMutableRawPointer!
    Show on GitHub

  • Designated initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Event instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafeMutablePointer<GdkEvent>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Event instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafePointer<GdkEvent>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Event instance.

    Declaration

    Swift

    @inlinable
public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Event instance.

    Declaration

    Swift

    @inlinable
public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Event instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafePointer<GdkEvent>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Event instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafeMutablePointer<GdkEvent>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from the underlying C data type. GdkEvent does not allow reference counting, so despite the name no actual retaining will occur. i.e., ownership is transferred to the Event instance.

    Declaration

    Swift

    @inlinable
public init(retaining op: UnsafeMutablePointer<GdkEvent>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements EventProtocol GdkEvent does not allow reference counting.

    Declaration

    Swift

    @inlinable
public init<T>(_ other: T) where T : EventProtocol

    Parameters

    other

    an instance of a related type that implements EventProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventProtocol.

    Declaration

    Swift

    @inlinable
public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventProtocol.

    Declaration

    Swift

    @inlinable
public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventProtocol.

    Declaration

    Swift

    @inlinable
public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventProtocol.

    Declaration

    Swift

    @inlinable
public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventProtocol.

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventProtocol.

    Declaration

    Swift

    @inlinable
public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventProtocol.

    Declaration

    Swift

    @inlinable
public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventProtocol.

    Declaration

    Swift

    @inlinable
public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Creates a new event of the given type. All fields are set to 0.

    Declaration

    Swift

    @inlinable
public init(type: GdkEventType)
    Show on GitHub

  • Checks all open displays for a GdkEvent to process,to be processed on, fetching events from the windowing system if necessary. See gdk_display_get_event().

    Declaration

    Swift

    @inlinable
public static func get() -> Event!
    Show on GitHub

  • If there is an event waiting in the event queue of some open display, returns a copy of it. See gdk_display_peek_event().

    Declaration

    Swift

    @inlinable
public static func peek() -> Event!
    Show on GitHub