EventControllerProtocol

public protocol EventControllerProtocol : ObjectProtocol

GtkEventController is a base, low-level implementation for event controllers. Those react to a series of GdkEvents, and possibly trigger actions as a consequence of those.

The EventControllerProtocol protocol exposes the methods and properties of an underlying GtkEventController 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 EventController. Alternatively, use EventControllerRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkEventController instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkEventController instance.

    Default Implementation

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

    Declaration

    Swift

    var event_controller_ptr: UnsafeMutablePointer<GtkEventController>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to EventControllerProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

EventController Class

  • Bind a EventControllerPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: EventControllerPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a EventController property

    Declaration

    Swift

    @inlinable
func get(property: EventControllerPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a EventController property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: EventControllerPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

EventController Class: EventControllerProtocol extension (methods and fields)

  • getPropagationPhase() Extension method

    Gets the propagation phase at which controller handles events.

    Declaration

    Swift

    @inlinable
func getPropagationPhase() -> GtkPropagationPhase
    Show on GitHub
  • getWidget() Extension method

    Returns the GtkWidget this controller relates to.

    Declaration

    Swift

    @inlinable
func getWidget() -> WidgetRef!
    Show on GitHub
  • handle(event:) Extension method

    Feeds an events into controller, so it can be interpreted and the controller actions triggered.

    Declaration

    Swift

    @inlinable
func handle<EventT>(event: EventT) -> Bool where EventT : EventProtocol
    Show on GitHub
  • reset() Extension method

    Resets the controller to a clean state. Every interaction the controller did through GtkEventController::handle-event will be dropped at this point.

    Declaration

    Swift

    @inlinable
func reset()
    Show on GitHub
  • setPropagation(phase:) Extension method

    Sets the propagation phase at which a controller handles events.

    If phase is GTK_PHASE_NONE, no automatic event handling will be performed, but other additional gesture maintenance will. In that phase, the events can be managed by calling gtk_event_controller_handle_event().

    Declaration

    Swift

    @inlinable
func setPropagation(phase: GtkPropagationPhase)
    Show on GitHub
  • propagationPhase Extension method

    Gets the propagation phase at which controller handles events.

    Declaration

    Swift

    @inlinable
var propagationPhase: GtkPropagationPhase { get nonmutating set }
    Show on GitHub
  • widget Extension method

    The widget receiving the GdkEvents that the controller will handle.

    Declaration

    Swift

    @inlinable
var widget: WidgetRef! { get }
    Show on GitHub