Class

AtkSocket

Description [src]

class Atk.Socket : Atk.Object {
  parent: AtkObject
}

Together with AtkPlug, AtkSocket provides the ability to embed accessibles from one process into another in a fashion that is transparent to assistive technologies. AtkSocket works as the container of AtkPlug, embedding it using the method atk_socket_embed(). Any accessible contained in the AtkPlug will appear to the assistive technologies as being inside the application that created the AtkSocket.

The communication between a AtkSocket and a AtkPlug is done by the IPC layer of the accessibility framework, normally implemented by the D-Bus based implementation of AT-SPI (at-spi2). If that is the case, at-spi-atk2 is the responsible to implement the abstract methods atk_plug_get_id() and atk_socket_embed(), so an ATK implementor shouldn’t reimplement them. The process that contains the AtkPlug is responsible to send the ID returned by atk_plug_id() to the process that contains the AtkSocket, so it could call the method atk_socket_embed() in order to embed it.

For the same reasons, an implementor doesn’t need to implement atk_object_get_n_accessible_children() and atk_object_ref_accessible_child(). All the logic related to those functions will be implemented by the IPC layer.

Hierarchy

hierarchy this AtkSocket implements_0 AtkComponent this--implements_0 ancestor_0 AtkObject ancestor_0--this ancestor_1 AtkObject ancestor_1--ancestor_0

Ancestors

Implements

Constructors

atk_socket_new

Creates a new AtkSocket.

Instance methods

atk_socket_embed

Embeds the children of an AtkPlug as the children of the AtkSocket. The plug may be in the same process or in a different process.

Available since: 1.30

atk_socket_is_occupied

Determines whether or not the socket has an embedded plug.

Available since: 1.30

Methods inherited from AtkObject (26)
atk_object_add_relationship

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

atk_object_connect_property_change_handler

Calls handler on property changes.

Deprecated since: 2.12

atk_object_get_accessible_id

Gets the accessible id of the accessible.

Available since: 2.34

atk_object_get_attributes

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.

Available since: 1.12

atk_object_get_description

Gets the accessible description of the accessible.

atk_object_get_index_in_parent

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

atk_object_get_layer

Gets the layer of the accessible.

atk_object_get_mdi_zorder

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

atk_object_get_n_accessible_children

Gets the number of accessible children of the accessible.

atk_object_get_name

Gets the accessible name of the accessible.

atk_object_get_object_locale

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

Available since: 2.8

atk_object_get_parent

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.

atk_object_get_role

Gets the role of the accessible.

atk_object_initialize

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.

atk_object_notify_state_change

Emits a state-change signal for the specified state.

atk_object_peek_parent

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

atk_object_ref_accessible_child

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.

atk_object_ref_relation_set

Gets the AtkRelationSet associated with the object.

atk_object_ref_state_set

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

atk_object_remove_property_change_handler

Removes a property change handler.

Deprecated since: 2.12

atk_object_remove_relationship

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

atk_object_set_accessible_id

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.

Available since: 2.34

atk_object_set_description

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 “”.

Methods inherited from AtkObject (26)
atk_object_add_relationship

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

atk_object_connect_property_change_handler

Calls handler on property changes.

Deprecated since: 2.12

atk_object_get_accessible_id

Gets the accessible id of the accessible.

Available since: 2.34

atk_object_get_attributes

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.

Available since: 1.12

atk_object_get_description

Gets the accessible description of the accessible.

atk_object_get_index_in_parent

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

atk_object_get_layer

Gets the layer of the accessible.

atk_object_get_mdi_zorder

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

atk_object_get_n_accessible_children

Gets the number of accessible children of the accessible.

atk_object_get_name

Gets the accessible name of the accessible.

atk_object_get_object_locale

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

Available since: 2.8

atk_object_get_parent

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.

atk_object_get_role

Gets the role of the accessible.

atk_object_initialize

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.

atk_object_notify_state_change

Emits a state-change signal for the specified state.

atk_object_peek_parent

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

atk_object_ref_accessible_child

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.

atk_object_ref_relation_set

Gets the AtkRelationSet associated with the object.

atk_object_ref_state_set

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

atk_object_remove_property_change_handler

Removes a property change handler.

Deprecated since: 2.12

atk_object_remove_relationship

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

atk_object_set_accessible_id

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.

Available since: 2.34

atk_object_set_description

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 “”.

Methods inherited from AtkComponent (16)
atk_component_add_focus_handler

Add the specified handler to the set of functions to be called when this object receives focus events (in or out). If the handler is already added it is not added again.

Deprecated since: 2.9.4

atk_component_contains

Checks whether the specified point is within the extent of the component.

atk_component_get_alpha

Returns the alpha value (i.e. the opacity) for this component, on a scale from 0 (fully transparent) to 1.0 (fully opaque).

Available since: 1.12

atk_component_get_extents

Gets the rectangle which gives the extent of the component.

atk_component_get_layer

Gets the layer of the component.

atk_component_get_mdi_zorder

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

atk_component_get_position

Gets the position of component in the form of a point specifying components top-left corner.

atk_component_get_size

Gets the size of the component in terms of width and height.

atk_component_grab_focus

Grabs focus for this component.

atk_component_ref_accessible_at_point

Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y.

atk_component_remove_focus_handler

Remove the handler specified by handler_id from the list of functions to be executed when this object receives focus events (in or out).

Deprecated since: 2.9.4

atk_component_scroll_to

Makes component visible on the screen by scrolling all necessary parents.

Available since: 2.30

atk_component_scroll_to_point

Move the top-left of component to a given position of the screen by scrolling all necessary parents.

Available since: 2.30

atk_component_set_extents

Sets the extents of component.

atk_component_set_position

Sets the position of component.

atk_component_set_size

Set the size of the component in terms of width and height.

Properties

Properties inherited from AtkObject (15)
Atk.Object:accessible-component-layer
No description available.
Atk.Object:accessible-component-mdi-zorder
No description available.
Atk.Object:accessible-description
No description available.
Atk.Object:accessible-hypertext-nlinks
No description available.
Atk.Object:accessible-name
No description available.
Atk.Object:accessible-parent
No description available.
Atk.Object:accessible-role
No description available.
Atk.Object:accessible-table-caption

Table caption.

Atk.Object:accessible-table-caption-object
No description available.
Atk.Object:accessible-table-column-description

Accessible table column description.

Atk.Object:accessible-table-column-header

Accessible table column header.

Atk.Object:accessible-table-row-description

Accessible table row description.

Atk.Object:accessible-table-row-header

Accessible table row header.

Atk.Object:accessible-table-summary
No description available.
Atk.Object:accessible-value

Numeric value of this object, in case being and AtkValue.

Properties inherited from AtkObject (15)
Atk.Object:accessible-component-layer
No description available.
Atk.Object:accessible-component-mdi-zorder
No description available.
Atk.Object:accessible-description
No description available.
Atk.Object:accessible-hypertext-nlinks
No description available.
Atk.Object:accessible-name
No description available.
Atk.Object:accessible-parent
No description available.
Atk.Object:accessible-role
No description available.
Atk.Object:accessible-table-caption

Table caption.

Atk.Object:accessible-table-caption-object
No description available.
Atk.Object:accessible-table-column-description

Accessible table column description.

Atk.Object:accessible-table-column-header

Accessible table column header.

Atk.Object:accessible-table-row-description

Accessible table row description.

Atk.Object:accessible-table-row-header

Accessible table row header.

Atk.Object:accessible-table-summary
No description available.
Atk.Object:accessible-value

Numeric value of this object, in case being and AtkValue.

Signals

Signals inherited from AtkObject (6)
Atk.Object::active-descendant-changed

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.

Atk.Object::children-changed

The signal “children-changed” is emitted when a child is added or removed form an object. It supports two details: “add” and “remove”

Atk.Object::focus-event

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

Deprecated since: 2.9.4

Atk.Object::property-change

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.

Atk.Object::state-change

The “state-change” signal is emitted when an object’s state changes. The detail value identifies the state type which has changed.

Atk.Object::visible-data-changed

The “visible-data-changed” signal is emitted when the visual appearance of the object changed.

Signals inherited from AtkObject (6)
Atk.Object::active-descendant-changed

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.

Atk.Object::children-changed

The signal “children-changed” is emitted when a child is added or removed form an object. It supports two details: “add” and “remove”

Atk.Object::focus-event

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

Deprecated since: 2.9.4

Atk.Object::property-change

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.

Atk.Object::state-change

The “state-change” signal is emitted when an object’s state changes. The detail value identifies the state type which has changed.

Atk.Object::visible-data-changed

The “visible-data-changed” signal is emitted when the visual appearance of the object changed.

Signals inherited from AtkComponent (1)
Atk.Component::bounds-changed

The ‘bounds-changed” signal is emitted when the bposition or size of the component changes.

Class structure

struct AtkSocketClass {
  AtkObjectClass parent_class;
  void (* embed) (
    AtkSocket* obj,
    const gchar* plug_id
  );
  
}
Class members
parent_class
AtkObjectClass
  No description available.
embed
void (* embed) (
    AtkSocket* obj,
    const gchar* plug_id
  )
  No description available.

Virtual methods

Atk.SocketClass.embed

Embeds the children of an AtkPlug as the children of the AtkSocket. The plug may be in the same process or in a different process.

Available since: 1.30