path: root/docs/reference/cspi/tmpl/spi_accessible.sgml

<!-- ##### SECTION Title ##### -->
Accessible Objects

<!-- ##### SECTION Short_Description ##### -->
The base accessibility interface which all accessible objects implement.

<!-- ##### SECTION Long_Description ##### -->
<para>
The Accessible interface provides for a hierarchical tree of accessible
objects corresponding to user interface components and content in an
accessible application.  Accessible objects provide name, descriptive
information, state information, and information on the "role" of the object in
the user interface.  The capabilities of these objects may be queried via
interface queries, as they are implemented via interface aggregation.  These
objects are located in a containment hierarchy with parent/child
relationships, and may have other functional relationships to objects within
the tree.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT Accessible ##### -->
<para>
An Accessible object is an opaque object used to refer to an accessible
object corresponding to an user interface element.
</para>

@objref: private data
@on_loan: private data
@ref_count: private data

<!-- ##### FUNCTION Accessible_ref ##### -->
<para>

</para>

@obj: 


<!-- ##### FUNCTION Accessible_unref ##### -->
<para>

</para>

@obj: 


<!-- ##### FUNCTION Accessible_getName ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getDescription ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getParent ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getChildCount ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getChildAtIndex ##### -->
<para>

</para>

@obj: 
@childIndex: 
@Returns: 


<!-- ##### FUNCTION Accessible_getIndexInParent ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getRelationSet ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getRole ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getRoleName ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getStateSet ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getAttributes ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getHostApplication ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getLocalizedRoleName ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isAction ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isApplication ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isComponent ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isDocument ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isEditableText ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isHypertext ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isImage ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isSelection ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isStreamableContent ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isTable ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isText ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_isValue ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getAction ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getApplication ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getComponent ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getDocument ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getEditableText ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getHypertext ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getImage ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getSelection ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getStreamableContent ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getTable ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getText ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_getValue ##### -->
<para>

</para>

@obj: 
@Returns: 


<!-- ##### FUNCTION Accessible_queryInterface ##### -->
<para>

</para>

@obj: 
@interface_name: 
@Returns: 


<!-- ##### ENUM AccessibleRole ##### -->
<para>

</para>

@SPI_ROLE_INVALID: 
@SPI_ROLE_ACCEL_LABEL: 
@SPI_ROLE_ALERT: 
@SPI_ROLE_ANIMATION: 
@SPI_ROLE_ARROW: 
@SPI_ROLE_CALENDAR: 
@SPI_ROLE_CANVAS: 
@SPI_ROLE_CHECK_BOX: 
@SPI_ROLE_CHECK_MENU_ITEM: 
@SPI_ROLE_COLOR_CHOOSER: 
@SPI_ROLE_COLUMN_HEADER: 
@SPI_ROLE_COMBO_BOX: 
@SPI_ROLE_DATE_EDITOR: 
@SPI_ROLE_DESKTOP_ICON: 
@SPI_ROLE_DESKTOP_FRAME: 
@SPI_ROLE_DIAL: 
@SPI_ROLE_DIALOG: 
@SPI_ROLE_DIRECTORY_PANE: 
@SPI_ROLE_DRAWING_AREA: 
@SPI_ROLE_FILE_CHOOSER: 
@SPI_ROLE_FILLER: 
@SPI_ROLE_FONT_CHOOSER: 
@SPI_ROLE_FRAME: 
@SPI_ROLE_GLASS_PANE: 
@SPI_ROLE_HTML_CONTAINER: 
@SPI_ROLE_ICON: 
@SPI_ROLE_IMAGE: 
@SPI_ROLE_INTERNAL_FRAME: 
@SPI_ROLE_LABEL: 
@SPI_ROLE_LAYERED_PANE: 
@SPI_ROLE_LIST: 
@SPI_ROLE_LIST_ITEM: 
@SPI_ROLE_MENU: 
@SPI_ROLE_MENU_BAR: 
@SPI_ROLE_MENU_ITEM: 
@SPI_ROLE_OPTION_PANE: 
@SPI_ROLE_PAGE_TAB: 
@SPI_ROLE_PAGE_TAB_LIST: 
@SPI_ROLE_PANEL: 
@SPI_ROLE_PASSWORD_TEXT: 
@SPI_ROLE_POPUP_MENU: 
@SPI_ROLE_PROGRESS_BAR: 
@SPI_ROLE_PUSH_BUTTON: 
@SPI_ROLE_RADIO_BUTTON: 
@SPI_ROLE_RADIO_MENU_ITEM: 
@SPI_ROLE_ROOT_PANE: 
@SPI_ROLE_ROW_HEADER: 
@SPI_ROLE_SCROLL_BAR: 
@SPI_ROLE_SCROLL_PANE: 
@SPI_ROLE_SEPARATOR: 
@SPI_ROLE_SLIDER: 
@SPI_ROLE_SPIN_BUTTON: 
@SPI_ROLE_SPLIT_PANE: 
@SPI_ROLE_STATUS_BAR: 
@SPI_ROLE_TABLE: 
@SPI_ROLE_TABLE_CELL: 
@SPI_ROLE_TABLE_COLUMN_HEADER: 
@SPI_ROLE_TABLE_ROW_HEADER: 
@SPI_ROLE_TEAROFF_MENU_ITEM: 
@SPI_ROLE_TERMINAL: 
@SPI_ROLE_TEXT: 
@SPI_ROLE_TOGGLE_BUTTON: 
@SPI_ROLE_TOOL_BAR: 
@SPI_ROLE_TOOL_TIP: 
@SPI_ROLE_TREE: 
@SPI_ROLE_TREE_TABLE: 
@SPI_ROLE_UNKNOWN: 
@SPI_ROLE_VIEWPORT: 
@SPI_ROLE_WINDOW: 
@SPI_ROLE_EXTENDED: 
@SPI_ROLE_HEADER: 
@SPI_ROLE_FOOTER: 
@SPI_ROLE_PARAGRAPH: 
@SPI_ROLE_RULER: 
@SPI_ROLE_APPLICATION: 
@SPI_ROLE_AUTOCOMPLETE: 
@SPI_ROLE_EDITBAR: 
@SPI_ROLE_EMBEDDED: 
@SPI_ROLE_ENTRY: 
@SPI_ROLE_CHART: 
@SPI_ROLE_CAPTION: 
@SPI_ROLE_DOCUMENT_FRAME: 
@SPI_ROLE_HEADING: 
@SPI_ROLE_PAGE: 
@SPI_ROLE_SECTION: 
@SPI_ROLE_FORM: 
@SPI_ROLE_REDUNDANT_OBJECT: 
@SPI_ROLE_LINK: 
@SPI_ROLE_INPUT_METHOD_WINDOW: 
@SPI_ROLE_LAST_DEFINED: 

<!-- ##### FUNCTION AccessibleRole_getName ##### -->
<para>

</para>

@role: 
@Returns: