Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ATContext

[16:7] extends: object

Communicates with platform-specific assistive technologies API. Each platform supported by GTK implements a GtkATContext subclass, and is responsible for updating the accessible state in response to state changes in GtkAccessible.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • ATContext (accessible_role = null, accessible = null, display = null)

    Creates a new GtkATContext instance for the given accessible role, accessible instance, and display connection. The GtkATContext implementation being instantiated will depend on the platform.

    • @p accessible_role is the accessible role used by the GtkATContext.
    • @p accessible is the GtkAccessible implementation using the GtkATContext.
    • @p display is the GdkDisplay used by the GtkATContext.
  • 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.
  • setOnStatechange (callback Fn, UserData = null)

    Emitted when the attributes of the accessible for the GtkATContext instance change.

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

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setAccessiblerole (string Value)

    The accessible role used by the AT context. Depending on the given role, different states and properties can be set or retrieved.

    • @p Value is the new property value.
    • @r None.
  • setDisplay (object Value)

    The GdkDisplay for the GtkATContext.

    • @p Value is the new property value.
    • @r None.
  • get_accessible ()

    Retrieves the GtkAccessible using this context.

  • get_accessible_role ()

    Retrieves the accessible role of this context.

class: ATContextMeta

[298:14] static extends: object

Generated metadata helpers for ATContext class surfaces.

Methods

  • properties ()

    Returns property metadata for ATContext.

    • @r A list.
  • signals ()

    Returns signal metadata for ATContext.

    • @r A list.

class: ATContextStatechangeCallback

[228:7] extends: object

Generated low-level callback wrapper for GIR callback state-change.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ATContextStatechangeCallback (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.