Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: Seat

[13:7] extends: object

Represents a collection of input devices that belong to a user.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • Seat (Handle = null)

    Creates a new Seat by wrapping a native handle or another wrapper.

    • @p Handle is the native handle or another wrapper whose handle to adopt.
  • 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.
  • asObject ()

    Wraps this handle as Object.

    • @r A Object 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.
  • setOnDeviceadded (callback Fn, UserData = null)

    Emitted when a new input device is related to this seat.

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

    Emitted when an input device is removed (e.g. unplugged).

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

    Emitted whenever a new tool is made known to the seat. The tool may later be assigned to a device (i.e. on proximity with a tablet). The device will emit the [signal@Gdk.Device::tool-changed] signal accordingly. A same tool may be used by several devices.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Seat Self, DeviceTool Tool).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnToolremoved (callback Fn, UserData = null)

    Emitted whenever a tool is no longer known to this @seat.

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

    Returns the capabilities this GdkSeat currently has.

  • get_devices (string capabilities)

    Returns the devices that match the given capabilities.

    • @p capabilities is capabilities to get devices for.
  • get_display ()

    Returns the GdkDisplay this seat belongs to.

  • get_keyboard ()

    Returns the device that routes keyboard events.

  • get_pointer ()

    Returns the device that routes pointer events.

  • get_tools ()

    Returns all GdkDeviceTools that are known to the application.

  • devices ()

    Returns get_devices as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_devices() when lazy or change-notify access is required.

    • @r An Aussom list of elements.
  • tools ()

    Returns get_tools as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_tools() when lazy or change-notify access is required.

    • @r An Aussom list of elements.

class: SeatMeta

[596:14] static extends: object

Generated metadata helpers for Seat class surfaces.

Methods

  • properties ()

    Returns property metadata for Seat.

    • @r A list.
  • signals ()

    Returns signal metadata for Seat.

    • @r A list.

class: SeatTooladdedCallback

[454:7] extends: object

Generated low-level callback wrapper for GIR callback tool-added.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • SeatTooladdedCallback (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, tool, 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: SeatDeviceaddedCallback

[312:7] extends: object

Generated low-level callback wrapper for GIR callback device-added.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • SeatDeviceaddedCallback (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, device, 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: SeatDeviceremovedCallback

[383:7] extends: object

Generated low-level callback wrapper for GIR callback device-removed.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • SeatDeviceremovedCallback (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, device, 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: SeatToolremovedCallback

[525:7] extends: object

Generated low-level callback wrapper for GIR callback tool-removed.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • SeatToolremovedCallback (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, tool, 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.