libatspi Reference Manual: atspi-document

atspi-document

Synopsis

                    AtspiDocument;
gchar *             atspi_document_get_locale           (AtspiDocument *obj,
                                                         GError **error);
gchar *             atspi_document_get_attribute_value  (AtspiDocument *obj,
                                                         gchar *attribute,
                                                         GError **error);
GHashTable *        atspi_document_get_attributes       (AtspiDocument *obj,
                                                         GError **error);

Object Hierarchy

  GInterface
   +----AtspiDocument

Known Implementations

AtspiDocument is implemented by AtspiAccessible.

Description

Details

AtspiDocument

typedef struct _AtspiDocument AtspiDocument;

atspi_document_get_locale ()

gchar *             atspi_document_get_locale           (AtspiDocument *obj,
                                                         GError **error);

Gets the locale associated with the document's content, e.g. the locale for LOCALE_TYPE_MESSAGES.

`obj` :	a pointer to the AtspiDocument object on which to operate.
Returns :	a string compliant with the POSIX standard for locale description.

atspi_document_get_attribute_value ()

gchar *             atspi_document_get_attribute_value  (AtspiDocument *obj,
                                                         gchar *attribute,
                                                         GError **error);

Warning

atspi_document_get_attribute_value has been deprecated since version 2.10 and should not be used in newly-written code. Use atspi_document_get_document_attribute_value instead. Rename to: atspi_document_get_document_attribute_value

Gets the value of a single attribute, if specified for the document as a whole.

`obj` :	a pointer to the AtspiDocument object on which to operate.
`attribute` :	a string indicating the name of a specific attribute.
Returns :	a string corresponding to the value of the specified attribute, or an empty string if the attribute is unspecified for the object.

atspi_document_get_attributes ()

GHashTable *        atspi_document_get_attributes       (AtspiDocument *obj,
                                                         GError **error);

Warning

atspi_document_get_attributes has been deprecated since version 2.10 and should not be used in newly-written code. Use atspi_document_get_document_attributes instead. Rename to: atspi_document_get_document_attributes

Gets all constant attributes for the document as a whole. For attributes that change within the document content, see atspi_text_get_attribute_run instead.

`obj` :	a pointer to the AtspiDocument object on which to operate.
Returns :	a GHashTable containing the constant attributes of the document, as name-value pairs. [element-type gchar* gchar*][transfer full]