ObjectProtocol

public protocol ObjectProtocol : ObjectProtocol

This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of AtkObject (or instances of AtkObject-derived types) are queried for properties which relate basic (and generic) properties of a UI component such as name and description. Instances of AtkObject may also be queried as to whether they implement other ATK interfaces (e.g. AtkAction, AtkComponent, etc.), as appropriate to the role which a given UI component plays in a user interface.

All UI components in an application which provide useful information or services to the user must provide corresponding AtkObject instances on request (in GTK+, for instance, usually on a call to gtk_widget_get_accessible ()), either via ATK support built into the toolkit for the widget class or ancestor class, or in the case of custom widgets, if the inherited AtkObject implementation is insufficient, via instances of a new AtkObject subclass.

See also: AtkObjectFactory, AtkRegistry. (GTK+ users see also GtkAccessible).

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

  • ptr

    Untyped pointer to the underlying AtkObject instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
  • object_ptr Default implementation

    Typed pointer to the underlying AtkObject instance.

    Default Implementation

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

    Declaration

    Swift

    var object_ptr: UnsafeMutablePointer<AtkObject>! { get }
  • Required Initialiser for types conforming to ObjectProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)

Object Class

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

    Declaration

    Swift

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

  • get(property:) Extension method

    Get the value of a Object property

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

  • set(property:value:) Extension method

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

Object signals

  • Connect a Swift signal handler to the given, typed ObjectSignalName signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func connect(signal s: ObjectSignalName, 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)

  • Connect a C signal handler to the given, typed ObjectSignalName signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func connect(signal s: ObjectSignalName, 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)

  • The “active-descendant-changed” signal is emitted by an object which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the object changes. For instance, a table will emit the signal when the cell in the table which has focus changes.

    Note

    This represents the underlying active-descendant-changed signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    arg1

    the newly focused object.

    handler

    The signal handler to call Run the given callback whenever the activeDescendantChanged signal is emitted

  • Typed active-descendant-changed signal for using the connect(signal:) methods

    Declaration

    Swift

    static var activeDescendantChangedSignal: ObjectSignalName { get }
  • The signal “children-changed” is emitted when a child is added or removed form an object. It supports two details: “add” and “remove”

    Note

    This represents the underlying children-changed signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onChildrenChanged(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ arg1: UInt, _ arg2: ObjectRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    arg1

    The index of the added or removed child. The value can be -1. This is used if the value is not known by the implementor when the child is added/removed or irrelevant.

    arg2

    A gpointer to the child AtkObject which was added or removed. If the child was removed, it is possible that it is not available for the implementor. In that case this pointer can be NULL.

    handler

    The signal handler to call Run the given callback whenever the childrenChanged signal is emitted

  • childrenChangedSignal Extension method

    Typed children-changed signal for using the connect(signal:) methods

    Declaration

    Swift

    static var childrenChangedSignal: ObjectSignalName { get }
  • onFocusEvent(flags:handler:) Extension method

    The signal “focus-event” is emitted when an object gained or lost focus.

    Note

    This represents the underlying focus-event signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onFocusEvent(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ arg1: Bool) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    arg1

    a boolean value which indicates whether the object gained or lost focus.

    handler

    The signal handler to call Run the given callback whenever the focusEvent signal is emitted

  • focusEventSignal Extension method

    Typed focus-event signal for using the connect(signal:) methods

    Declaration

    Swift

    static var focusEventSignal: ObjectSignalName { get }
  • The signal “property-change” is emitted when an object’s property value changes. arg1 contains an AtkPropertyValues with the name and the new value of the property whose value has changed. Note that, as with GObject notify, getting this signal does not guarantee that the value of the property has actually changed; it may also be emitted when the setter of the property is called to reinstate the previous value.

    Toolkit implementor note: ATK implementors should use g_object_notify() to emit property-changed notifications. AtkObject::property-changed is needed by the implementation of atk_add_global_event_listener() because GObject notify doesn’t support emission hooks.

    Note

    This represents the underlying property-change signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onPropertyChange(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ arg1: PropertyValuesRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    arg1

    an AtkPropertyValues containing the new value of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the propertyChange signal is emitted

  • propertyChangeSignal Extension method

    Typed property-change signal for using the connect(signal:) methods

    Declaration

    Swift

    static var propertyChangeSignal: ObjectSignalName { get }
  • The “state-change” signal is emitted when an object’s state changes. The detail value identifies the state type which has changed.

    Note

    This represents the underlying state-change signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onStateChange(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ arg1: String, _ arg2: Bool) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    arg1

    The name of the state which has changed

    arg2

    A boolean which indicates whether the state has been set or unset.

    handler

    The signal handler to call Run the given callback whenever the stateChange signal is emitted

  • stateChangeSignal Extension method

    Typed state-change signal for using the connect(signal:) methods

    Declaration

    Swift

    static var stateChangeSignal: ObjectSignalName { get }
  • The “visible-data-changed” signal is emitted when the visual appearance of the object changed.

    Note

    This represents the underlying visible-data-changed signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    handler

    The signal handler to call Run the given callback whenever the visibleDataChanged signal is emitted

  • visibleDataChangedSignal Extension method

    Typed visible-data-changed signal for using the connect(signal:) methods

    Declaration

    Swift

    static var visibleDataChangedSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-component-layer signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleComponentLayer(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleComponentLayer signal is emitted

  • Typed notify::accessible-component-layer signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleComponentLayerSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-component-mdi-zorder signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleComponentMdiZorder(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleComponentMdiZorder signal is emitted

  • Typed notify::accessible-component-mdi-zorder signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleComponentMdiZorderSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-description signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleDescription(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleDescription signal is emitted

  • Typed notify::accessible-description signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleDescriptionSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-hypertext-nlinks signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleHypertextNlinks(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleHypertextNlinks signal is emitted

  • Typed notify::accessible-hypertext-nlinks signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleHypertextNlinksSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-name signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleName(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleName signal is emitted

  • notifyAccessibleNameSignal Extension method

    Typed notify::accessible-name signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleNameSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-parent signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleParent(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleParent signal is emitted

  • notifyAccessibleParentSignal Extension method

    Typed notify::accessible-parent signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleParentSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-role signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleRole(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleRole signal is emitted

  • notifyAccessibleRoleSignal Extension method

    Typed notify::accessible-role signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleRoleSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-table-caption signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleTableCaption(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleTableCaption signal is emitted

  • Typed notify::accessible-table-caption signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleTableCaptionSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-table-caption-object signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleTableCaptionObject(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleTableCaptionObject signal is emitted

  • Typed notify::accessible-table-caption-object signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleTableCaptionObjectSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-table-column-description signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleTableColumnDescription(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleTableColumnDescription signal is emitted

  • Typed notify::accessible-table-column-description signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleTableColumnDescriptionSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-table-column-header signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleTableColumnHeader(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleTableColumnHeader signal is emitted

  • Typed notify::accessible-table-column-header signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleTableColumnHeaderSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-table-row-description signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleTableRowDescription(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleTableRowDescription signal is emitted

  • Typed notify::accessible-table-row-description signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleTableRowDescriptionSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-table-row-header signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleTableRowHeader(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleTableRowHeader signal is emitted

  • Typed notify::accessible-table-row-header signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleTableRowHeaderSignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-table-summary signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleTableSummary(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleTableSummary signal is emitted

  • Typed notify::accessible-table-summary signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleTableSummarySignal: ObjectSignalName { get }
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::accessible-value signal

    Declaration

    Swift

    @discardableResult
    @inlinable
    func onNotifyAccessibleValue(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ObjectRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags

    unownedSelf

    Reference to instance of self

    pspec

    the GParamSpec of the property which changed.

    handler

    The signal handler to call Run the given callback whenever the notifyAccessibleValue signal is emitted

  • notifyAccessibleValueSignal Extension method

    Typed notify::accessible-value signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccessibleValueSignal: ObjectSignalName { get }

Object Class: ObjectProtocol extension (methods and fields)

  • add(relationship:target:) Extension method

    Adds a relationship of the specified type with the specified target.

    Declaration

    Swift

    @inlinable
    func add<ObjectT>(relationship: AtkRelationType, target: ObjectT) -> Bool where ObjectT : ObjectProtocol
  • Calls handler on property changes.

    connect_property_change_handler is deprecated: Connect directly to #AtkObject::property-change or the relevant #GObject::notify signal for each desired property.

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func connectPropertyChange(handler: UnsafeMutablePointer<AtkPropertyChangeHandler?>!) -> Int
  • getAccessibleId() Extension method

    Gets the accessible id of the accessible.

    Declaration

    Swift

    @inlinable
    func getAccessibleId() -> String!
  • getAttributes() Extension method

    Get a list of properties applied to this object as a whole, as an AtkAttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit “name-value pair” AtkAttributeSet properties.

    Declaration

    Swift

    @inlinable
    func getAttributes() -> UnsafeMutablePointer<AtkAttributeSet>!
  • getDescription() Extension method

    Gets the accessible description of the accessible.

    Declaration

    Swift

    @inlinable
    func getDescription() -> String!
  • getIndexInParent() Extension method

    Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

    Declaration

    Swift

    @inlinable
    func getIndexInParent() -> Int
  • getLayer() Extension method

    Gets the layer of the accessible.

    get_layer is deprecated: Use atk_component_get_layer instead.

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func getLayer() -> AtkLayer
  • getMdiZorder() Extension method

    Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.

    get_mdi_zorder is deprecated: Use atk_component_get_mdi_zorder instead.

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func getMdiZorder() -> Int
  • getNAccessibleChildren() Extension method

    Gets the number of accessible children of the accessible.

    Declaration

    Swift

    @inlinable
    func getNAccessibleChildren() -> Int
  • getName() Extension method

    Gets the accessible name of the accessible.

    Declaration

    Swift

    @inlinable
    func getName() -> String!
  • getObjectLocale() Extension method

    Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible.

    Declaration

    Swift

    @inlinable
    func getObjectLocale() -> String!
  • getParent() Extension method

    Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with atk_object_set_parent(), and will return it with this method.

    If you are only interested on the parent assigned with atk_object_set_parent(), use atk_object_peek_parent().

    Declaration

    Swift

    @inlinable
    func getParent() -> Atk.ObjectRef!
  • getRole() Extension method

    Gets the role of the accessible.

    Declaration

    Swift

    @inlinable
    func getRole() -> AtkRole
  • initialize(data:) Extension method

    This function is called when implementing subclasses of AtkObject. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of AtkObject

    Declaration

    Swift

    @inlinable
    func initialize(data: gpointer? = nil)
  • Emits a state-change signal for the specified state.

    Note that as a general rule when the state of an existing object changes, emitting a notification is expected.

    Declaration

    Swift

    @inlinable
    func notifyStateChange(state: AtkState, value: Bool)
  • peekParent() Extension method

    Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns nil.

    This method is intended as an utility for ATK implementors, and not to be exposed to accessible tools. See atk_object_get_parent() for further reference.

    Declaration

    Swift

    @inlinable
    func peekParent() -> Atk.ObjectRef!
  • refAccessibleChild(i:) Extension method

    Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on.

    Declaration

    Swift

    @inlinable
    func refAccessibleChild(i: Int) -> Atk.ObjectRef!
  • refRelationSet() Extension method

    Gets the AtkRelationSet associated with the object.

    Declaration

    Swift

    @inlinable
    func refRelationSet() -> Atk.RelationSetRef!
  • refStateSet() Extension method

    Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.

    Declaration

    Swift

    @inlinable
    func refStateSet() -> Atk.StateSetRef!
  • Removes a property change handler.

    remove_property_change_handler is deprecated: See atk_object_connect_property_change_handler()

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func removePropertyChangeHandler(handlerId: Int)
  • remove(relationship:target:) Extension method

    Removes a relationship of the specified type with the specified target.

    Declaration

    Swift

    @inlinable
    func remove<ObjectT>(relationship: AtkRelationType, target: ObjectT) -> Bool where ObjectT : ObjectProtocol
  • setAccessibleId(name:) Extension method

    Sets the accessible ID of the accessible. This is not meant to be presented to the user, but to be an ID which is stable over application development. Typically, this is the gtkbuilder ID. Such an ID will be available for instance to identify a given well-known accessible object for tailored screen reading, or for automatic regression testing.

    Declaration

    Swift

    @inlinable
    func setAccessibleId(name: UnsafePointer<gchar>!)
  • set(description:) Extension method

    Sets the accessible description of the accessible. You can’t set the description to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use “”.

    Declaration

    Swift

    @inlinable
    func set(description: UnsafePointer<gchar>!)
  • set(name:) Extension method

    Sets the accessible name of the accessible. You can’t set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use “”.

    Declaration

    Swift

    @inlinable
    func set(name: UnsafePointer<gchar>!)
  • set(parent:) Extension method

    Sets the accessible parent of the accessible. parent can be NULL.

    Declaration

    Swift

    @inlinable
    func set<ObjectT>(parent: ObjectT) where ObjectT : ObjectProtocol
  • set(role:) Extension method

    Sets the role of the accessible.

    Declaration

    Swift

    @inlinable
    func set(role: AtkRole)
  • focusTrackerNotify() Extension method

    Cause the focus tracker functions which have been specified to be executed for the object.

    focus_tracker_notify is deprecated: Focus tracking has been dropped as a feature to be implemented by ATK itself. As #AtkObject::focus-event was deprecated in favor of a #AtkObject::state-change signal, in order to notify a focus change on your implementation, you can use atk_object_notify_state_change() instead.

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func focusTrackerNotify()
  • accessibleId Extension method

    Gets the accessible id of the accessible.

    Declaration

    Swift

    @inlinable
    var accessibleId: String! { get nonmutating set }
  • attributes Extension method

    Get a list of properties applied to this object as a whole, as an AtkAttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit “name-value pair” AtkAttributeSet properties.

    Declaration

    Swift

    @inlinable
    var attributes: UnsafeMutablePointer<AtkAttributeSet>! { get }
  • description Extension method

    Gets the accessible description of the accessible.

    Declaration

    Swift

    @inlinable
    var description: String! { get nonmutating set }
  • indexInParent Extension method

    Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

    Declaration

    Swift

    @inlinable
    var indexInParent: Int { get }
  • layer Extension method

    Gets the layer of the accessible.

    get_layer is deprecated: Use atk_component_get_layer instead.

    Declaration

    Swift

    @inlinable
    var layer: AtkLayer { get }
  • mdiZorder Extension method

    Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.

    get_mdi_zorder is deprecated: Use atk_component_get_mdi_zorder instead.

    Declaration

    Swift

    @inlinable
    var mdiZorder: Int { get }
  • nAccessibleChildren Extension method

    Gets the number of accessible children of the accessible.

    Declaration

    Swift

    @inlinable
    var nAccessibleChildren: Int { get }
  • name Extension method

    Gets the accessible name of the accessible.

    Declaration

    Swift

    @inlinable
    var name: String! { get nonmutating set }
  • objectLocale Extension method

    Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible.

    Declaration

    Swift

    @inlinable
    var objectLocale: String! { get }
  • parent Extension method

    Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with atk_object_set_parent(), and will return it with this method.

    If you are only interested on the parent assigned with atk_object_set_parent(), use atk_object_peek_parent().

    Declaration

    Swift

    @inlinable
    var parent: Atk.ObjectRef! { get nonmutating set }
  • role Extension method

    Gets the role of the accessible.

    Declaration

    Swift

    @inlinable
    var role: AtkRole { get nonmutating set }
  • _parent Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var _parent: GObject { get }
  • _description Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var _description: UnsafeMutablePointer<gchar>! { get }
  • _name Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var _name: UnsafeMutablePointer<gchar>! { get }
  • accessibleParent Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var accessibleParent: ObjectRef! { get }
  • _role Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var _role: AtkRole { get }
  • relationSet Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var relationSet: RelationSetRef! { get }
  • _layer Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var _layer: AtkLayer { get }