EventControllerKeyProtocol

public protocol EventControllerKeyProtocol : EventControllerProtocol

GtkEventControllerKey is an event controller meant for situations where you need access to key events.

This object was added in 3.24.

The EventControllerKeyProtocol protocol exposes the methods and properties of an underlying GtkEventControllerKey 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 EventControllerKey. Alternatively, use EventControllerKeyRef 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 GtkEventControllerKey instance.
Declaration
Swift

var ptr: UnsafeMutableRawPointer! { get }
Show on GitHub
event_controller_key_ptr Default implementation
Typed pointer to the underlying GtkEventControllerKey instance.

Default Implementation

Return the stored, untyped pointer as a typed pointer to the GtkEventControllerKey instance.
Declaration
Swift

var event_controller_key_ptr: UnsafeMutablePointer<GtkEventControllerKey>! { get }
Show on GitHub
init(raw:)
Required Initialiser for types conforming to EventControllerKeyProtocol
Declaration
Swift

init(raw: UnsafeMutableRawPointer)
Show on GitHub

EventControllerKey Class


                    
                    
                    bind(property:to:_:flags:transformFrom:transformTo:)

Extension method

Bind a EventControllerKeyPropertyName source property to a given target object.

Declaration

Swift

@discardableResult
@inlinable
func bind<Q, T>(property source_property: EventControllerKeyPropertyName, 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 EventControllerKey property

Declaration

Swift

@inlinable
func get(property: EventControllerKeyPropertyName) -> 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 EventControllerKey property. Note that this will only have an effect on properties that are writable and not construct-only!

Declaration

Swift

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

Parameters


                                property

the property to get the value for

Return Value

the value of the named property

Show on GitHub

EventControllerKey signals


                    
                    
                    connect(signal:flags:handler:)

Extension method

Connect a Swift signal handler to the given, typed EventControllerKeySignalName signal

Declaration

Swift

@discardableResult
@inlinable
func connect(signal s: EventControllerKeySignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

Parameters

`signal`	The signal to connect
`flags`	The connection flags to use
`data`	A pointer to user data to provide to the callback
`destroyData`	A `GClosureNotify` C function to destroy the data pointed to by `userData`
`handler`	The Swift signal handler (function or callback) to invoke on the given signal

Return Value

The signal handler ID (always greater than 0 for successful connections)

Show on GitHub


                    
                    
                    connect(signal:flags:data:destroyData:signalHandler:)

Extension method

Connect a C signal handler to the given, typed EventControllerKeySignalName signal

Declaration

Swift

@discardableResult
@inlinable
func connect(signal s: EventControllerKeySignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

Parameters

`signal`	The signal to connect
`flags`	The connection flags to use
`data`	A pointer to user data to provide to the callback
`destroyData`	A `GClosureNotify` C function to destroy the data pointed to by `userData`
`signalHandler`	The C function to be called on the given signal

Return Value

The signal handler ID (always greater than 0 for successful connections)

Show on GitHub


                    
                    
                    onFocusIn(flags:handler:)

Extension method

Note

This represents the underlying focus-in signal

Declaration

Swift

@discardableResult
@inlinable
func onFocusIn(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: EventControllerKeyRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`handler`	The signal handler to call Run the given callback whenever the `focusIn` signal is emitted

Show on GitHub

focusInSignal Extension method
Typed focus-in signal for using the connect(signal:) methods
Declaration
Swift

static var focusInSignal: EventControllerKeySignalName { get }
Show on GitHub


                    
                    
                    onFocusOut(flags:handler:)

Extension method

Note

This represents the underlying focus-out signal

Declaration

Swift

@discardableResult
@inlinable
func onFocusOut(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: EventControllerKeyRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`handler`	The signal handler to call Run the given callback whenever the `focusOut` signal is emitted

Show on GitHub

focusOutSignal Extension method
Typed focus-out signal for using the connect(signal:) methods
Declaration
Swift

static var focusOutSignal: EventControllerKeySignalName { get }
Show on GitHub


                    
                    
                    onImUpdate(flags:handler:)

Extension method

Note

This represents the underlying im-update signal

Declaration

Swift

@discardableResult
@inlinable
func onImUpdate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: EventControllerKeyRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`handler`	The signal handler to call Run the given callback whenever the `imUpdate` signal is emitted

Show on GitHub

imUpdateSignal Extension method
Typed im-update signal for using the connect(signal:) methods
Declaration
Swift

static var imUpdateSignal: EventControllerKeySignalName { get }
Show on GitHub


                    
                    
                    onKeyPressed(flags:handler:)

Extension method

This signal is emitted whenever a key is pressed.

Note

This represents the underlying key-pressed signal

Declaration

Swift

@discardableResult
@inlinable
func onKeyPressed(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: EventControllerKeyRef, _ keyval: UInt, _ keycode: UInt, _ state: Gdk.ModifierType) -> Bool) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`keyval`	the pressed key.
`keycode`	the raw code of the pressed key.
`state`	the bitmask, representing the state of modifier keys and pointer buttons. See `GdkModifierType`.
`handler`	`true` if the key press was handled, `false` otherwise. Run the given callback whenever the `keyPressed` signal is emitted

Show on GitHub

keyPressedSignal Extension method
Typed key-pressed signal for using the connect(signal:) methods
Declaration
Swift

static var keyPressedSignal: EventControllerKeySignalName { get }
Show on GitHub


                    
                    
                    onKeyReleased(flags:handler:)

Extension method

This signal is emitted whenever a key is released.

Note

This represents the underlying key-released signal

Declaration

Swift

@discardableResult
@inlinable
func onKeyReleased(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: EventControllerKeyRef, _ keyval: UInt, _ keycode: UInt, _ state: Gdk.ModifierType) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`keyval`	the released key.
`keycode`	the raw code of the released key.
`state`	the bitmask, representing the state of modifier keys and pointer buttons. See `GdkModifierType`.
`handler`	The signal handler to call Run the given callback whenever the `keyReleased` signal is emitted

Show on GitHub

keyReleasedSignal Extension method
Typed key-released signal for using the connect(signal:) methods
Declaration
Swift

static var keyReleasedSignal: EventControllerKeySignalName { get }
Show on GitHub


                    
                    
                    onModifiers(flags:handler:)

Extension method

Note

This represents the underlying modifiers signal

Declaration

Swift

@discardableResult
@inlinable
func onModifiers(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: EventControllerKeyRef, _ object: Gdk.ModifierType) -> Bool) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`object`	none
`handler`	The signal handler to call Run the given callback whenever the `modifiers` signal is emitted

Show on GitHub

modifiersSignal Extension method
Typed modifiers signal for using the connect(signal:) methods
Declaration
Swift

static var modifiersSignal: EventControllerKeySignalName { get }
Show on GitHub

EventControllerKey Class: EventControllerKeyProtocol extension (methods and fields)


                    
                    
                    forward(widget:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func forward<WidgetT>(widget: WidgetT) -> Bool where WidgetT : WidgetProtocol

Show on GitHub

getGroup() Extension method
Undocumented
Declaration
Swift

@inlinable func getGroup() -> Int
Show on GitHub
getImContext() Extension method
Gets the IM context of a key controller.
Declaration
Swift

@inlinable func getImContext() -> IMContextRef!
Show on GitHub


                    
                    
                    set(imContext:)

Extension method

Undocumented

Declaration

Swift

@inlinable
func set<IMContextT>(imContext: IMContextT) where IMContextT : IMContextProtocol

Show on GitHub

group Extension method
Undocumented
Declaration
Swift

@inlinable var group: Int { get }
Show on GitHub
imContext Extension method
Gets the IM context of a key controller.
Declaration
Swift

@inlinable var imContext: IMContextRef! { get nonmutating set }
Show on GitHub

EventControllerKeyProtocol

Declaration

Default Implementation

Declaration

Declaration

EventControllerKey Class

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

EventControllerKey signals

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

EventControllerKey Class: EventControllerKeyProtocol extension (methods and fields)

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration