Class: Atk::Socket

Inherits:
Object show all
Defined in:
(unknown)

Instance Method Summary collapse

Methods inherited from Object

#accessible_component_layer, #accessible_component_layer=, #accessible_component_mdi_zorder, #accessible_component_mdi_zorder=, #accessible_description, #accessible_description=, #accessible_help_text, #accessible_help_text=, #accessible_hypertext_nlinks, #accessible_hypertext_nlinks=, #accessible_id, #accessible_id=, #accessible_name, #accessible_name=, #accessible_parent, #accessible_parent=, #accessible_role, #accessible_role=, #accessible_table_caption, #accessible_table_caption=, #accessible_table_caption_object, #accessible_table_caption_object=, #accessible_table_column_description, #accessible_table_column_description=, #accessible_table_column_header, #accessible_table_column_header=, #accessible_table_row_description, #accessible_table_row_description=, #accessible_table_row_header, #accessible_table_row_header=, #accessible_table_summary, #accessible_table_summary=, #accessible_value, #accessible_value=, #add_relationship, #attributes, #connect_property_change_handler, #description, #description=, #help_text, #help_text=, #index_in_parent, #layer, #mdi_zorder, #n_accessible_children, #name, #name=, #notify_state_change, #object_locale, #parent, #parent=, #peek_parent, #ref_accessible_child, #ref_relation_set, #ref_state_set, #remove_property_change_handler, #remove_relationship, #role, #role=

Constructor Details

#initializeAtk::Object

Creates a new Atk::Socket.

Instance Method Details

#embed(plug_id) ⇒ nil

Embeds the children of an Atk::Plug as the children of the Atk::Socket. The plug may be in the same process or in a different process.

The class item used by this function should be filled in by the IPC layer (usually at-spi2-atk). The implementor of the AtkSocket should call this function and pass the id for the plug as returned by atk_plug_get_id(). It is the responsibility of the application to pass the plug id on to the process implementing the Atk::Socket as needed.

Parameters:

  • plug_id (String)

    the ID of an Atk::Plug

Returns:

  • (nil)

#is_occupiedBoolean

Determines whether or not the socket has an embedded plug.

Returns:

  • (Boolean)

    TRUE if a plug is embedded in the socket