Changes to introspection generation to remove DOCTYPE and XML

[platform/core/uifw/at-spi2-atk.git] / docs / reference / cspi / tmpl / spi_accessible.sgml

diff --git a/docs/reference/cspi/tmpl/spi_accessible.sgml b/docs/reference/cspi/tmpl/spi_accessible.sgml
index da975e7..5de4673 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_accessible.sgml
+++ b/docs/reference/cspi/tmpl/spi_accessible.sgml
@@ -2,11 +2,19 @@
 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 ##### -->
@@ -14,13 +22,18 @@ Accessible Objects
 
 </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: 
-@ref_count: 
+@objref: private data
+@on_loan: private data
+@ref_count: private data
 
 <!-- ##### FUNCTION Accessible_ref ##### -->
 <para>
@@ -28,8 +41,6 @@ Accessible Objects
 </para>
 
 @obj: 
-<!-- # Unused Parameters # -->
-@Returns: 
 
 
 <!-- ##### FUNCTION Accessible_unref ##### -->
@@ -38,8 +49,6 @@ Accessible Objects
 </para>
 
 @obj: 
-<!-- # Unused Parameters # -->
-@Returns: 
 
 
 <!-- ##### FUNCTION Accessible_getName ##### -->
@@ -133,6 +142,33 @@ Accessible Objects
 @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>
 
@@ -160,6 +196,15 @@ Accessible Objects
 @Returns: 
 
 
+<!-- ##### FUNCTION Accessible_isDocument ##### -->
+<para>
+
+</para>
+
+@obj: 
+@Returns: 
+
+
 <!-- ##### FUNCTION Accessible_isEditableText ##### -->
 <para>
 
@@ -259,6 +304,15 @@ Accessible Objects
 @Returns: 
 
 
+<!-- ##### FUNCTION Accessible_getDocument ##### -->
+<para>
+
+</para>
+
+@obj: 
+@Returns: 
+
+
 <!-- ##### FUNCTION Accessible_getEditableText ##### -->
 <para>
 
@@ -416,6 +470,25 @@ Accessible Objects
 @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 ##### -->