Accessibility::Document Interface Reference

Primarily a 'tagging' interface which indicates the start of document content in the Accessibility hierarchy. More...

import "Accessibility_Document.idl";

List of all members.

Public Member Functions
string	getLocale (in LOCALE_TYPE lctype)
	Gets the locale associated with the document's content.
string	getAttributeValue (in string attributename)
	Gets the value of a single attribute, if specified for the document as a whole.
AttributeSet	getAttributes ()
	Gets all attributes specified for a document as a whole.

---

Detailed Description

Primarily a 'tagging' interface which indicates the start of document content in the Accessibility hierarchy.

Accessible objects below the node implementing Document are normally assumed to be part of the document content. Attributes of Document are those attributes associated with the document as a whole. Objects that implement Document are expected to implement Collection as well.

Note:

events fired by Document instances include

• "document:load-complete" A pending (static) document content load has completed.
• "document:reload" A reload of the document content has been initiated.
• "document:load-stopped" Loading of the document content has been interrupted.
• "document:content-changed" The contents of the Document container has changed.
• "document:attributes-changed" The global attributes (i.e. document-wide attributes) of the Document have changed.

State values with special semantics for Document include STATE_BUSY, which can indicate that a document is in the process of loading. This allows AT clients to detect objects for which they should expect a "document:load-complete" event.

See also:

Accessibility::Collection

Since:

AT-SPI 1.7.0

Definition at line 55 of file Accessibility_Document.idl.

---

Member Function Documentation

string Accessibility::Document::getLocale (  in LOCALE_TYPE  lctype  )

Gets the locale associated with the document's content. For the current message locale, use lctype LOCALE_TYPE_MESSAGES. Parameters: lctype,:  the LocaleType for which the locale is queried. Returns: a string compliant with the POSIX standard for locale description.

string Accessibility::Document::getAttributeValue (  in string  attributename  )

Gets the value of a single attribute, if specified for the document as a whole. Parameters: attributename,:  a string indicating the name of a specific attribute (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.

AttributeSet Accessibility::Document::getAttributes (   )

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.

---

The documentation for this interface was generated from the following file:

• Accessibility_Document.idl

---