AtspiAccessible

## AtspiAccessible AtspiAccessible |

## Synopsis

                        AtspiAccessible;
                        AtspiAccessibleClass;
    AtspiAccessible *   atspi_accessible_new                (AtspiApplication *app,
                                                             const gchar *path);
    gchar *             atspi_role_get_name                 (AtspiRole role);
    gchar *             atspi_accessible_get_name           (AtspiAccessible *obj,
                                                             GError **error);
    gchar *             atspi_accessible_get_description    (AtspiAccessible *obj,
                                                             GError **error);
    AtspiAccessible *   atspi_accessible_get_parent         (AtspiAccessible *obj,
                                                             GError **error);
    gint                atspi_accessible_get_child_count    (AtspiAccessible *obj,
                                                             GError **error);
    AtspiAccessible *   atspi_accessible_get_child_at_index (AtspiAccessible *obj,
                                                             gint child_index,
                                                             GError **error);
    gint                atspi_accessible_get_index_in_parent
                                                            (AtspiAccessible *obj,
                                                             GError **error);
    GArray *            atspi_accessible_get_relation_set   (AtspiAccessible *obj,
                                                             GError **error);
    AtspiRole           atspi_accessible_get_role           (AtspiAccessible *obj,
                                                             GError **error);
    gchar *             atspi_accessible_get_role_name      (AtspiAccessible *obj,
                                                             GError **error);
    gchar *             atspi_accessible_get_localized_role_name
                                                            (AtspiAccessible *obj,
                                                             GError **error);
    AtspiStateSet *     atspi_accessible_get_state_set      (AtspiAccessible *obj);
    GHashTable *        atspi_accessible_get_attributes     (AtspiAccessible *obj,
                                                             GError **error);
    GArray *            atspi_accessible_get_attributes_as_array
                                                            (AtspiAccessible *obj,
                                                             GError **error);
    gchar *             atspi_accessible_get_toolkit_name   (AtspiAccessible *obj,
                                                             GError **error);
    gchar *             atspi_accessible_get_toolkit_version
                                                            (AtspiAccessible *obj,
                                                             GError **error);
    AtspiAccessible *   atspi_accessible_get_application    (AtspiAccessible *obj,
                                                             GError **error);
    AtspiAction *       atspi_accessible_get_action         (AtspiAccessible *obj);
    AtspiCollection *   atspi_accessible_get_collection     (AtspiAccessible *obj);
    AtspiComponent *    atspi_accessible_get_component      (AtspiAccessible *obj);
    AtspiDocument *     atspi_accessible_get_document       (AtspiAccessible *obj);
    AtspiEditableText * atspi_accessible_get_editable_text  (AtspiAccessible *obj);
    AtspiHyperlink *    atspi_accessible_get_hyperlink      (AtspiAccessible *obj);
    AtspiHypertext *    atspi_accessible_get_hypertext      (AtspiAccessible *obj);
    AtspiImage *        atspi_accessible_get_image          (AtspiAccessible *obj);
    AtspiSelection *    atspi_accessible_get_selection      (AtspiAccessible *obj);
    AtspiTable *        atspi_accessible_get_table          (AtspiAccessible *obj);
    AtspiText *         atspi_accessible_get_text           (AtspiAccessible *obj);
    AtspiValue *        atspi_accessible_get_value          (AtspiAccessible *obj);
    GArray *            atspi_accessible_get_interfaces     (AtspiAccessible *obj);

## Object Hierarchy

      GObject
       +----AtspiObject
             +----AtspiAccessible

## Implemented Interfaces

AtspiAccessible implements AtspiAction, AtspiCollection, AtspiComponent, AtspiDocument, AtspiEditableText, AtspiHypertext, AtspiImage, AtspiSelection, AtspiTable, AtspiText and AtspiValue.

## Description

## Details

### AtspiAccessible

    typedef struct _AtspiAccessible AtspiAccessible;

### AtspiAccessibleClass

    typedef struct {
      AtspiObjectClass parent_class;
    } AtspiAccessibleClass;

### atspi_accessible_new ()

    AtspiAccessible *   atspi_accessible_new                (AtspiApplication *app,
                                                             const gchar *path);

`app` : |
`path` : |
Returns : |

### atspi_role_get_name ()

    gchar *             atspi_role_get_name                 (AtspiRole role);

Get a localizeable string that indicates the name of an AtspiAccessibleRole. <em>DEPRECATED.</em>

`role` : | an AtspiAccessibleRole object to query.
Returns : | a localizable string name for an AtspiAccessibleRole enumerated type.

### atspi_accessible_get_name ()

    gchar *             atspi_accessible_get_name           (AtspiAccessible *obj,
                                                             GError **error);

Get the name of an AtspiAccessible object.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`error` : |
Returns : | a UTF-8 string indicating the name of the AtspiAccessible object. or NULL on exception

### atspi_accessible_get_description ()

    gchar *             atspi_accessible_get_description    (AtspiAccessible *obj,
                                                             GError **error);

Get the description of an AtspiAccessible object.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`error` : |
Returns : | a UTF-8 string describing the AtspiAccessible object. or NULL on exception

### atspi_accessible_get_parent ()

    AtspiAccessible *   atspi_accessible_get_parent         (AtspiAccessible *obj,
                                                             GError **error);

Get an AtspiAccessible object's parent container.

`obj` : | a pointer to the AtspiAccessible object to query.
`error` : |
Returns : | a pointer to the AtspiAccessible object which contains the given AtspiAccessible instance, or NULL if the `obj` has no parent container. [transfer full]

### atspi_accessible_get_child_count ()

    gint                atspi_accessible_get_child_count    (AtspiAccessible *obj,
                                                             GError **error);

Get the number of children contained by an AtspiAccessible object.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`error` : |
Returns : | a long indicating the number of AtspiAccessible children contained by an AtspiAccessible object. or -1 on exception

### atspi_accessible_get_child_at_index ()

    AtspiAccessible *   atspi_accessible_get_child_at_index (AtspiAccessible *obj,
                                                             gint child_index,
                                                             GError **error);

Get the AtspiAccessible child of an AtspiAccessible object at a given index.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`child_index` : | a long indicating which child is specified.
`error` : |
Returns : | a pointer to the AtspiAccessible child object at index `child_index`. or NULL on exception. [transfer full]

### atspi_accessible_get_index_in_parent ()

    gint                atspi_accessible_get_index_in_parent
                                                            (AtspiAccessible *obj,
                                                             GError **error);

Get the index of an AtspiAccessible object in its containing AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`error` : |
Returns : | a glong indicating the index of the AtspiAccessible object in its parent (i.e. containing) AtspiAccessible instance, or -1 if `obj` has no containing parent or on exception.

### atspi_accessible_get_relation_set ()

    GArray *            atspi_accessible_get_relation_set   (AtspiAccessible *obj,
                                                             GError **error);

Get the set of AtspiRelation objects which describe this AtspiAccessible object's relationships with other AtspiAccessible objects.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`error` : |
Returns : | an array of AtspiAccessibleRelation pointers. or NULL on exception. [element-type AtspiAccessible*][transfer full AtspiAccessible*]

### atspi_accessible_get_role ()

    AtspiRole           atspi_accessible_get_role           (AtspiAccessible *obj,
                                                             GError **error);

Get the UI role of an AtspiAccessible object. A UTF-8 string describing this role can be obtained via `atspi_accessible_getRoleName()`.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`error` : |
Returns : | the AtspiRole of the object.

### atspi_accessible_get_role_name ()

    gchar *             atspi_accessible_get_role_name      (AtspiAccessible *obj,
                                                             GError **error);

Get a UTF-8 string describing the role this object plays in the UI. This method will return useful values for roles that fall outside the enumeration used in `atspi_accessible_getRole()`.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`error` : |
Returns : | a UTF-8 string specifying the role of this AtspiAccessible object.

### atspi_accessible_get_localized_role_name ()

    gchar *             atspi_accessible_get_localized_role_name
                                                            (AtspiAccessible *obj,
                                                             GError **error);

Get a UTF-8 string describing the (localized) role this object plays in the UI. This method will return useful values for roles that fall outside the enumeration used in `atspi_accessible_getRole()`.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`error` : |
Returns : | a UTF-8 string specifying the role of this AtspiAccessible object.

### atspi_accessible_get_state_set ()

    AtspiStateSet *     atspi_accessible_get_state_set      (AtspiAccessible *obj);

Gets the current state of an object.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
Returns : | a pointer to an AtspiStateSet representing the object's current state. [transfer full]

### atspi_accessible_get_attributes ()

    GHashTable *        atspi_accessible_get_attributes     (AtspiAccessible *obj,
                                                             GError **error);

Get the AttributeSet representing any assigned name-value pair attributes or annotations for this object. For typographic, textual, or textually-semantic attributes, see atspi_text_get_attributes instead.

`obj` : | The AtspiAccessible being queried.
`error` : |
Returns : | The name-value-pair attributes assigned to this object. [element-type gchar* gchar*][transfer full gchar* gchar*]

### atspi_accessible_get_attributes_as_array ()

    GArray *            atspi_accessible_get_attributes_as_array
                                                            (AtspiAccessible *obj,
                                                             GError **error);

Get the AttributeSet representing any assigned name-value pair attributes or annotations for this object. For typographic, textual, or textually-semantic attributes, see atspi_text_get_attributes_as_array instead.

`obj` : | The AtspiAccessible being queried.
`error` : |
Returns : | The name-value-pair attributes assigned to this object. [element-type gchar*][transfer full gchar*]

### atspi_accessible_get_toolkit_name ()

    gchar *             atspi_accessible_get_toolkit_name   (AtspiAccessible *obj,
                                                             GError **error);

Get the toolkit for a AtspiAccessible object. Only works on application root objects.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`error` : |
Returns : | a UTF-8 string indicating the toolkit name for the AtspiAccessible object. or NULL on exception

### atspi_accessible_get_toolkit_version ()

    gchar *             atspi_accessible_get_toolkit_version
                                                            (AtspiAccessible *obj,
                                                             GError **error);

Get the application id for a AtspiAccessible object. Only works on application root objects.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
`error` : |
Returns : | a gint indicating the id for the AtspiAccessible object. or -1 on exception

### atspi_accessible_get_application ()

    AtspiAccessible *   atspi_accessible_get_application    (AtspiAccessible *obj,
                                                             GError **error);

Get the containing AtspiApplication for an object.

`obj` : | The AtspiAccessible being queried.
`error` : |
Returns : | the containing AtspiApplication instance for this object. [transfer full]

### atspi_accessible_get_action ()

    AtspiAction *       atspi_accessible_get_action         (AtspiAccessible *obj);

Get the AtspiAction interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiAction interface instance, or NULL if `obj` does not implement AtspiAction. [transfer full]

### atspi_accessible_get_collection ()

    AtspiCollection *   atspi_accessible_get_collection     (AtspiAccessible *obj);

Get the AtspiCollection interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiCollection interface instance, or NULL if `obj` does not implement AtspiCollection. [transfer full]

### atspi_accessible_get_component ()

    AtspiComponent *    atspi_accessible_get_component      (AtspiAccessible *obj);

Get the AtspiComponent interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiComponent interface instance, or NULL if `obj` does not implement AtspiComponent. [transfer full]

### atspi_accessible_get_document ()

    AtspiDocument *     atspi_accessible_get_document       (AtspiAccessible *obj);

Get the AtspiDocument interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiDocument interface instance, or NULL if `obj` does not implement AtspiDocument. [transfer full]

### atspi_accessible_get_editable_text ()

    AtspiEditableText * atspi_accessible_get_editable_text  (AtspiAccessible *obj);

Get the AtspiEditableText interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiEditableText interface instance, or NULL if `obj` does not implement AtspiEditableText. [transfer full]

### atspi_accessible_get_hyperlink ()

    AtspiHyperlink *    atspi_accessible_get_hyperlink      (AtspiAccessible *obj);

Get the AtspiHyperlink associated with the given AtspiAccessible, if supported.

`obj` : | a pointer to the AtspiAccessible object on which to operate.
Returns : | the AtspiHyperlink object associated with the given AtspiAccessible, or NULL if not supported. [transfer full]

### atspi_accessible_get_hypertext ()

    AtspiHypertext *    atspi_accessible_get_hypertext      (AtspiAccessible *obj);

Get the AtspiHypertext interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiHypertext interface instance, or NULL if `obj` does not implement AtspiHypertext. [transfer full]

### atspi_accessible_get_image ()

    AtspiImage *        atspi_accessible_get_image          (AtspiAccessible *obj);

Get the AtspiImage interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiImage interface instance, or NULL if `obj` does not implement AtspiImage. [transfer full]

### atspi_accessible_get_selection ()

    AtspiSelection *    atspi_accessible_get_selection      (AtspiAccessible *obj);

Get the AtspiSelection interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiSelection interface instance, or NULL if `obj` does not implement AtspiSelection. [transfer full]

### atspi_accessible_get_table ()

    AtspiTable *        atspi_accessible_get_table          (AtspiAccessible *obj);

Get the AtspiTable interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiTable interface instance, or NULL if `obj` does not implement AtspiTable. [transfer full]

### atspi_accessible_get_text ()

    AtspiText *         atspi_accessible_get_text           (AtspiAccessible *obj);

Get the AtspiTable interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiText interface instance, or NULL if `obj` does not implement AtspiText. [transfer full]

### atspi_accessible_get_value ()

    AtspiValue *        atspi_accessible_get_value          (AtspiAccessible *obj);

Get the AtspiTable interface for an AtspiAccessible.

`obj` : | a pointer to the AtspiAccessible instance to query.
Returns : | a pointer to an AtspiValue interface instance, or NULL if `obj` does not implement AtspiValue. [transfer full]

### atspi_accessible_get_interfaces ()

    GArray *            atspi_accessible_get_interfaces     (AtspiAccessible *obj);

obj: The AtspiAccessible to query.

`obj` : |
Returns : | A GArray of strings describing the interfaces supported by the object. Interfaces are denoted in short-hand (ie, "Component", "Text", etc.). [element-type gchar*][transfer full gchar*]