Object

Object Hierarchy:

Description:

[ CCode ( type_id = "atk_object_get_type ()" ) ]
public class Object : Object

The base object class for the Accessibility Toolkit API.

This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of Object (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 Object may also be queried as to whether they implement other ATK interfaces (e.g. Action, Component, 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 Object 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 Object implementation is insufficient, via instances of a new Object subclass.

See [class@AtkObjectFactory], [class@AtkRegistry]. (GTK+ users see also GtkAccessible).

All known sub-classes:

Plug

Socket

Required by:

TableCell

Window

Namespace: Atk

Package: atk

Content:

Properties:

public int accessible_component_layer { get; }
public int accessible_component_mdi_zorder { get; }
public string accessible_description { owned get; set; }
public int accessible_hypertext_nlinks { get; }
public string accessible_name { owned get; set; }
public Object accessible_parent { owned get; set; }
public Role accessible_role { get; set; }
public string accessible_table_caption { owned get; set; }
Table caption.
public Object accessible_table_caption_object { owned get; set; }
public string accessible_table_column_description { owned get; set; }
Accessible table column description.
public Object accessible_table_column_header { owned get; set; }
Accessible table column header.
public string accessible_table_row_description { owned get; set; }
Accessible table row description.
public Object accessible_table_row_header { owned get; set; }
Accessible table row header.
public Object accessible_table_summary { owned get; set; }
public double accessible_value { get; set; }
Numeric value of this object, in case being and AtkValue.

Creation methods:

protected Object ()

Methods:

public bool add_relationship (RelationType relationship, Object target)
Adds a relationship of the specified type with the specified target.
public virtual uint connect_property_change_handler (PropertyChangeHandler handler)
Calls handler on property changes.
public unowned string get_accessible_id ()
Gets the accessible id of the accessible.
public virtual AttributeSet get_attributes ()
Get a list of properties applied to this object as a whole, as an AttributeSet consisting of name-value pairs.
public virtual unowned string get_description ()
Gets the accessible description of the accessible.
public virtual int 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.
public virtual Layer get_layer ()
Gets the layer of the accessible.
public virtual int get_mdi_zorder ()
Gets the zorder of the accessible.
public int get_n_accessible_children ()
Gets the number of accessible children of the accessible.
public virtual int get_n_children ()
public virtual unowned string get_name ()
Gets the accessible name of the accessible.
public virtual unowned string get_object_locale ()
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of this.
public virtual unowned Object get_parent ()
Gets the accessible parent of the accessible.
public virtual Role get_role ()
Gets the role of the accessible.
public virtual void initialize (void* data)
This function is called when implementing subclasses of Object.
public void notify_state_change (State state, bool value)
Emits a state-change signal for the specified state.
public unowned Object peek_parent ()
Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent.
public Object ref_accessible_child (int i)
Gets a reference to the specified accessible child of the object.
public virtual RelationSet ref_relation_set ()
Gets the RelationSet associated with the object.
public virtual StateSet ref_state_set ()
Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.
public virtual void remove_property_change_handler (uint handler_id)
Removes a property change handler.
public bool remove_relationship (RelationType relationship, Object target)
Removes a relationship of the specified type with the specified target.
public void set_accessible_id (string name)
Sets the accessible ID of the accessible.
public virtual void set_description (string description)
Sets the accessible description of the accessible.
public virtual void set_name (string name)
Sets the accessible name of the accessible.
public virtual void set_parent (Object parent)
Sets the accessible parent of the accessible.
public virtual void set_role (Role role)
Sets the role of the accessible.

Signals:

public virtual signal void active_descendant_changed (Object child)
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.
public virtual signal void children_changed (uint change_index, Object changed_child)
The signal "children-changed" is emitted when a child is added or removed from an object.
public virtual signal void focus_event (bool focus_in)
The signal "focus-event" is emitted when an object gained or lost focus.
public virtual signal void property_change (PropertyValues values)
The signal "property-change" is emitted when an object's property value changes.
public virtual signal void state_change (string name, bool state_set)
The "state-change" signal is emitted when an object's state changes.
public virtual signal void visible_data_changed ()
The "visible-data-changed" signal is emitted when the visual appearance of the object changed.

Fields:

public unowned string description
public Layer layer
public unowned string name
public unowned RelationSet relation_set
public Role role

Inherited Members:

All known members inherited from class GLib.Object