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.
-
Untyped pointer to the underlying
AtkObject
instance.Declaration
Swift
var ptr: UnsafeMutableRawPointer! { get }
-
object_ptr
Default implementationTyped 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)
-
bind(property:
Extension methodto: _: flags: transformFrom: transformTo: ) 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 transformationtransform_to
ValueTransformer
to use for backwards transformationReturn 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:
Extension methodvalue: ) 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
-
connect(signal:
Extension methodflags: handler: ) Connect a Swift signal handler to the given, typed
ObjectSignalName
signalDeclaration
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 byuserData
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(signal:
Extension methodflags: data: destroyData: signalHandler: ) Connect a C signal handler to the given, typed
ObjectSignalName
signalDeclaration
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 byuserData
signalHandler
The C function to be called on the given signal
Return Value
The signal handler ID (always greater than 0 for successful connections)
-
onActiveDescendantChanged(flags:
Extension methodhandler: ) 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 underlyingactive-descendant-changed
signalDeclaration
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 -
activeDescendantChangedSignal
Extension methodTyped
active-descendant-changed
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var activeDescendantChangedSignal: ObjectSignalName { get }
-
onChildrenChanged(flags:
Extension methodhandler: ) 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 underlyingchildren-changed
signalDeclaration
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 methodTyped
children-changed
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var childrenChangedSignal: ObjectSignalName { get }
-
onFocusEvent(flags:
Extension methodhandler: ) The signal “focus-event” is emitted when an object gained or lost focus.
Note
This represents the underlyingfocus-event
signalDeclaration
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 methodTyped
focus-event
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var focusEventSignal: ObjectSignalName { get }
-
onPropertyChange(flags:
Extension methodhandler: ) The signal “property-change” is emitted when an object’s property value changes.
arg1
contains anAtkPropertyValues
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 ofatk_add_global_event_listener()
because GObject notify doesn’t support emission hooks.Note
This represents the underlyingproperty-change
signalDeclaration
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 methodTyped
property-change
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var propertyChangeSignal: ObjectSignalName { get }
-
onStateChange(flags:
Extension methodhandler: ) 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 underlyingstate-change
signalDeclaration
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 methodTyped
state-change
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var stateChangeSignal: ObjectSignalName { get }
-
onVisibleDataChanged(flags:
Extension methodhandler: ) The “visible-data-changed” signal is emitted when the visual appearance of the object changed.
Note
This represents the underlyingvisible-data-changed
signalDeclaration
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 methodTyped
visible-data-changed
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var visibleDataChangedSignal: ObjectSignalName { get }
-
onNotifyAccessibleComponentLayer(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-component-layer
signalDeclaration
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 -
notifyAccessibleComponentLayerSignal
Extension methodTyped
notify::accessible-component-layer
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleComponentLayerSignal: ObjectSignalName { get }
-
onNotifyAccessibleComponentMdiZorder(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-component-mdi-zorder
signalDeclaration
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 -
notifyAccessibleComponentMdiZorderSignal
Extension methodTyped
notify::accessible-component-mdi-zorder
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleComponentMdiZorderSignal: ObjectSignalName { get }
-
onNotifyAccessibleDescription(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-description
signalDeclaration
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 -
notifyAccessibleDescriptionSignal
Extension methodTyped
notify::accessible-description
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleDescriptionSignal: ObjectSignalName { get }
-
onNotifyAccessibleHypertextNlinks(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-hypertext-nlinks
signalDeclaration
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 -
notifyAccessibleHypertextNlinksSignal
Extension methodTyped
notify::accessible-hypertext-nlinks
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleHypertextNlinksSignal: ObjectSignalName { get }
-
onNotifyAccessibleName(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-name
signalDeclaration
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 methodTyped
notify::accessible-name
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleNameSignal: ObjectSignalName { get }
-
onNotifyAccessibleParent(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-parent
signalDeclaration
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 methodTyped
notify::accessible-parent
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleParentSignal: ObjectSignalName { get }
-
onNotifyAccessibleRole(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-role
signalDeclaration
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 methodTyped
notify::accessible-role
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleRoleSignal: ObjectSignalName { get }
-
onNotifyAccessibleTableCaption(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-table-caption
signalDeclaration
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 -
notifyAccessibleTableCaptionSignal
Extension methodTyped
notify::accessible-table-caption
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleTableCaptionSignal: ObjectSignalName { get }
-
onNotifyAccessibleTableCaptionObject(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-table-caption-object
signalDeclaration
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 -
notifyAccessibleTableCaptionObjectSignal
Extension methodTyped
notify::accessible-table-caption-object
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleTableCaptionObjectSignal: ObjectSignalName { get }
-
onNotifyAccessibleTableColumnDescription(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-table-column-description
signalDeclaration
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 -
notifyAccessibleTableColumnDescriptionSignal
Extension methodTyped
notify::accessible-table-column-description
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleTableColumnDescriptionSignal: ObjectSignalName { get }
-
onNotifyAccessibleTableColumnHeader(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-table-column-header
signalDeclaration
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 -
notifyAccessibleTableColumnHeaderSignal
Extension methodTyped
notify::accessible-table-column-header
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleTableColumnHeaderSignal: ObjectSignalName { get }
-
onNotifyAccessibleTableRowDescription(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-table-row-description
signalDeclaration
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 -
notifyAccessibleTableRowDescriptionSignal
Extension methodTyped
notify::accessible-table-row-description
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleTableRowDescriptionSignal: ObjectSignalName { get }
-
onNotifyAccessibleTableRowHeader(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-table-row-header
signalDeclaration
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 -
notifyAccessibleTableRowHeaderSignal
Extension methodTyped
notify::accessible-table-row-header
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleTableRowHeaderSignal: ObjectSignalName { get }
-
onNotifyAccessibleTableSummary(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-table-summary
signalDeclaration
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 -
notifyAccessibleTableSummarySignal
Extension methodTyped
notify::accessible-table-summary
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleTableSummarySignal: ObjectSignalName { get }
-
onNotifyAccessibleValue(flags:
Extension methodhandler: ) 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 tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_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 underlyingnotify::accessible-value
signalDeclaration
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 methodTyped
notify::accessible-value
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyAccessibleValueSignal: ObjectSignalName { get }
-
add(relationship:
Extension methodtarget: ) 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
-
connectPropertyChange(handler:
Extension method) 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 methodGets the accessible id of the accessible.
Declaration
Swift
@inlinable func getAccessibleId() -> String!
-
getAttributes()
Extension methodGet 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 methodGets the accessible description of the accessible.
Declaration
Swift
@inlinable func getDescription() -> String!
-
getIndexInParent()
Extension methodGets 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 methodGets 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 methodGets 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 methodGets the number of accessible children of the accessible.
Declaration
Swift
@inlinable func getNAccessibleChildren() -> Int
-
getName()
Extension methodGets the accessible name of the accessible.
Declaration
Swift
@inlinable func getName() -> String!
-
getObjectLocale()
Extension methodGets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of
accessible
.Declaration
Swift
@inlinable func getObjectLocale() -> String!
-
getParent()
Extension methodGets 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 withatk_object_set_parent()
, and will return it with this method.If you are only interested on the parent assigned with
atk_object_set_parent()
, useatk_object_peek_parent()
.Declaration
Swift
@inlinable func getParent() -> Atk.ObjectRef!
-
getRole()
Extension methodGets 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 ofAtkObject
Declaration
Swift
@inlinable func initialize(data: gpointer? = nil)
-
notifyStateChange(state:
Extension methodvalue: ) 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 methodGets 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 methodGets the
AtkRelationSet
associated with the object.Declaration
Swift
@inlinable func refRelationSet() -> Atk.RelationSetRef!
-
refStateSet()
Extension methodGets 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!
-
removePropertyChangeHandler(handlerId:
Extension method) 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:
Extension methodtarget: ) 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 methodCause 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 methodGets the accessible id of the accessible.
Declaration
Swift
@inlinable var accessibleId: String! { get nonmutating set }
-
attributes
Extension methodGet 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 methodGets the accessible description of the accessible.
Declaration
Swift
@inlinable var description: String! { get nonmutating set }
-
indexInParent
Extension methodGets 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 methodGets the layer of the accessible.
get_layer is deprecated: Use atk_component_get_layer instead.
Declaration
Swift
@inlinable var layer: AtkLayer { get }
-
mdiZorder
Extension methodGets 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 methodGets the number of accessible children of the accessible.
Declaration
Swift
@inlinable var nAccessibleChildren: Int { get }
-
name
Extension methodGets the accessible name of the accessible.
Declaration
Swift
@inlinable var name: String! { get nonmutating set }
-
objectLocale
Extension methodGets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of
accessible
.Declaration
Swift
@inlinable var objectLocale: String! { get }
-
parent
Extension methodGets 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 withatk_object_set_parent()
, and will return it with this method.If you are only interested on the parent assigned with
atk_object_set_parent()
, useatk_object_peek_parent()
.Declaration
Swift
@inlinable var parent: Atk.ObjectRef! { get nonmutating set }
-
role
Extension methodGets the role of the accessible.
Declaration
Swift
@inlinable var role: AtkRole { get nonmutating set }
-
_parent
Extension methodUndocumented
Declaration
Swift
@inlinable var _parent: GObject { get }
-
_description
Extension methodUndocumented
Declaration
Swift
@inlinable var _description: UnsafeMutablePointer<gchar>! { get }
-
_name
Extension methodUndocumented
Declaration
Swift
@inlinable var _name: UnsafeMutablePointer<gchar>! { get }
-
accessibleParent
Extension methodUndocumented
Declaration
Swift
@inlinable var accessibleParent: ObjectRef! { get }
-
_role
Extension methodUndocumented
Declaration
Swift
@inlinable var _role: AtkRole { get }
-
relationSet
Extension methodUndocumented
Declaration
Swift
@inlinable var relationSet: RelationSetRef! { get }
-
_layer
Extension methodUndocumented
Declaration
Swift
@inlinable var _layer: AtkLayer { get }