class: EventControllerKeyMeta

[535:14] static extends: object

Generated metadata helpers for EventControllerKey class surfaces.

Methods

• signals ()

  Returns signal metadata for EventControllerKey.

  • @r A list.

class: EventControllerKeyImupdateCallback

[252:7] extends: object

Generated low-level callback wrapper for GIR callback im-update.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• EventControllerKeyImupdateCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: EventControllerKey

[13:7] extends: object

Provides access to key events.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• EventControllerKey ()

  Creates a new event controller that will handle key events.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asEventController ()

  Wraps this handle as EventController.

  • @r A EventController object.

• connectSignal (string Name, CallbackObj)

  Connects one generated callback wrapper to a named signal.

  • @p Name is the signal name.
  • @p CallbackObj is the generated callback wrapper to connect.
  • @r The connected handler id.

• disconnectSignalHandler (int HandlerId)

  Disconnects one retained signal handler id.

  • @p HandlerId is the signal handler id to disconnect.
  • @r None.

• setOnImupdate (callback Fn, UserData = null)

  Emitted whenever the input method context filters away a keypress and prevents the @controller receiving it. See [method@Gtk.EventControllerKey.set_im_context] and [method@Gtk.IMContext.filter_keypress].

  • @p Fn is the Aussom callback.
  • @p Fn is called with (EventControllerKey Self).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnKeypressed (callback Fn, UserData = null)

  Emitted whenever a key is pressed.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (EventControllerKey Self, int Keyval, int Keycode, string State).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnKeyreleased (callback Fn, UserData = null)

  Emitted whenever a key is released.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (EventControllerKey Self, int Keyval, int Keycode, string State).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnModifiers (callback Fn, UserData = null)

  Emitted whenever the state of modifier keys and pointer buttons change.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (EventControllerKey Self, string State).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• forward (object widget)

  Forwards the current event of this @controller to a @widget. This function can only be used in handlers for the [signal@Gtk.EventControllerKey::key-pressed], [signal@Gtk.EventControllerKey::key-released] or [signal@Gtk.EventControllerKey::modifiers] signals.

  • @p widget is a GtkWidget.

• get_group ()

  Gets the key group of the current event of this @controller. See [method@Gdk.KeyEvent.get_layout].

• get_im_context ()

  Gets the input method context of the key @controller.

• set_im_context (object im_context)

  Sets the input method context of the key @controller.

  • @p im_context is a GtkIMContext.
  • @r None.

class: EventControllerKeyKeyreleasedCallback

[393:7] extends: object

Generated low-level callback wrapper for GIR callback key-released.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• EventControllerKeyKeyreleasedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, keyval, keycode, state, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: EventControllerKeyModifiersCallback

[464:7] extends: object

Generated low-level callback wrapper for GIR callback modifiers.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• EventControllerKeyModifiersCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, state, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: EventControllerKeyKeypressedCallback

[322:7] extends: object

Generated low-level callback wrapper for GIR callback key-pressed.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• EventControllerKeyKeypressedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, keyval, keycode, state, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.