AccessibleDocument Interface

AccessibleDocument Interface

Functions

Description

Functions

AccessibleDocument_ref ()

void
AccessibleDocument_ref (AccessibleDocument *obj);

Increment the reference count for an AccessibleDocument object.

Parameters

obj

a pointer to the AccessibleDocument object on which to operate.

 

AccessibleDocument_unref ()

void
AccessibleDocument_unref (AccessibleDocument *obj);

Decrement the reference count for an AccessibleDocument object.

Parameters

obj

a pointer to the Accessible object on which to operate.

 

AccessibleDocument_getAttributeValue ()

char *
AccessibleDocument_getAttributeValue (AccessibleDocument *obj,
                                      char *attribute);

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

(name-value pair) being queried.

Returns a string corresponding to the value of the specified attribute, or an empty string if the attribute is unspecified for the object.

Parameters

obj

a pointer to the Accessible object on which to operate.

 

attribute

a string indicating the name of a specific attribute

 

AccessibleDocument_getAttributes ()

AccessibleAttributeSet *
AccessibleDocument_getAttributes (AccessibleDocument *obj);

Gets all attributes specified for a document as a whole.

For attributes which change within the document content, see Accessibility::Text::getAttributes instead.

Returns an ::AttributeSet containing the attributes of the document, as name-value pairs.

Since AT-SPI 1.8.0

Parameters

obj

a pointer to the Accessible object on which to operate.

 

AccessibleDocument_getLocale ()

char *
AccessibleDocument_getLocale (AccessibleDocument *obj);

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

Parameters

obj

a pointer to the Accessible object on which to operate.

 

Returns

a string compliant with the POSIX standard for locale description.

Types and Values