API changes for out--of-process accessibles, and support ParentOf
authorMike Gorse <mgorse@novell.com>
Fri, 6 Nov 2009 19:41:53 +0000 (14:41 -0500)
committerMike Gorse <mgorse@novell.com>
Fri, 6 Nov 2009 19:41:53 +0000 (14:41 -0500)
Modified DBus api to return bus names along with object paths to support
out-of-process children.
Also, support the new ParentOf relationship.

xml/org.freedesktop.atspi.Accessible.xml
xml/org.freedesktop.atspi.Component.xml
xml/org.freedesktop.atspi.Relation.xml
xml/org.freedesktop.atspi.Table.xml
xml/org.freedesktop.atspi.Tree.xml

index 5c3c25f..b8a2cbe 100644 (file)
@@ -94,7 +94,7 @@
     A string describing the object in more detail than name.
   </tp:docstring>
   </tp:property>
-  <tp:property name="parent" type="o" access="read">
+  <tp:property name="parent" type="(so)" access="read">
   <tp:docstring>
     The Accessible object which is this object's containing object.
   </tp:docstring>
       an in parameter indicating which child is requested (zero-indexed).
     </tp:docstring>
     </arg>
-    <arg direction="out" type="o" tp:type="Accessible">
+    <arg direction="out" type="(so)" tp:type="Accessible">
     <tp:docstring>
       the 'nth' ::Accessible child of this object.
     </tp:docstring>
     <tp:docstring>
       Get a set defining this object's relationship to other accessible objects.
     </tp:docstring>
-    <arg direction="out" type="a(uao)" tp:type="RelationSet">
+    <arg direction="out" type="a(ua(so))" tp:type="RelationSet">
     <tp:docstring>
       A RelationSet defining this object's relationships.
     </tp:docstring>
     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
       <p>Get the containing Application for this object.</p>
     </tp:docstring>
-    <arg direction="out" type="o" tp:type="Application">
+    <arg direction="out" type="(so)" tp:type="Application">
     <tp:docstring>
       The Application instance to which this object belongs.
     </tp:docstring>
index df75d59..90a7e69 100644 (file)
     <arg direction="in" name="x" type="i"/>
     <arg direction="in" name="y" type="i"/>
     <arg direction="in" name="coord_type" type="u" tp:type="COORD_TYPE"/>
-    <arg direction="out" type="o" tp:type="Accessible">
+    <arg direction="out" type="(so)" tp:type="Accessible">
     <tp:docstring>
       The Accessible child whose bounding box contains the specified point. 
     </tp:docstring>
index 792899c..6eafa54 100644 (file)
   </tp:enumvalue>
   <tp:enumvalue suffix="RELATION_NODE_CHILD_OF" value="7">
   <tp:docstring>
-    Reserved for future use. 
+    Object is a child of the target.
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_EXTENDED" value="8">
+  <tp:enumvalue suffix="RELATION_NODE_PARENT_OF" value="8">
+  <tp:docstring>
+    Object is a parent of the target.
+  </tp:docstring>
+  </tp:enumvalue>
+  <tp:enumvalue suffix="RELATION_EXTENDED" value="9">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
     <p>Used to indicate that a relationship exists, but its type is not specified in the enumeration
       and must be obtained via a call to getRelationTypeName.  </p>
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_FLOWS_TO" value="9">
+  <tp:enumvalue suffix="RELATION_FLOWS_TO" value="10">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
     <p>Object renders content which flows logically to another object.  
       For instance, text in a paragraph may flow to another object which is not the 
       'next sibling' in the accessibility hierarchy. </p>
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_FLOWS_FROM" value="10">
+  <tp:enumvalue suffix="RELATION_FLOWS_FROM" value="11">
   <tp:docstring>
     Reciprocal of RELATION_FLOWS_TO. 
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_SUBWINDOW_OF" value="11">
+  <tp:enumvalue suffix="RELATION_SUBWINDOW_OF" value="12">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
     <p>Object is visually and semantically considered a subwindow of another object, even though
       it is not the object's child.  Useful when dealing with embedded applications and other cases
       where the widget hierarchy does not map cleanly to the onscreen presentation.  </p>
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_EMBEDS" value="12">
+  <tp:enumvalue suffix="RELATION_EMBEDS" value="13">
   <tp:docstring>
     Similar to SUBWINDOW_OF, but specifically used for cross-process embedding.  
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_EMBEDDED_BY" value="13">
+  <tp:enumvalue suffix="RELATION_EMBEDDED_BY" value="14">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
     <p>Reciprocal of RELATION_EMBEDS; Used to denote content rendered by embedded renderers that
       live in a separate process space from the embedding context.  </p>
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_POPUP_FOR" value="14">
+  <tp:enumvalue suffix="RELATION_POPUP_FOR" value="15">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
     <p>Denotes that the object is a transient window or frame associated with another onscreen object.
       Similar to TOOLTIP_FOR, but more general.  Useful for windows which are technically 
       the previous toplevel ROLE_FRAME object may still be the active window.  </p>
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_PARENT_WINDOW_OF" value="15">
+  <tp:enumvalue suffix="RELATION_PARENT_WINDOW_OF" value="16">
   <tp:docstring>
     This is the reciprocal relation to RELATION_POPUP_FOR. 
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_DESCRIPTION_FOR" value="16">
+  <tp:enumvalue suffix="RELATION_DESCRIPTION_FOR" value="17">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
     <p>Indicates that an object provides descriptive information 
       about another object; more verbose than RELATION_LABEL_FOR. </p>
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_DESCRIBED_BY" value="17">
+  <tp:enumvalue suffix="RELATION_DESCRIBED_BY" value="18">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
     <p>Indicates that another object provides descriptive information 
       about this object; more verbose than RELATION_LABELLED_BY. </p>
   </tp:docstring>
   </tp:enumvalue>
-  <tp:enumvalue suffix="RELATION_LAST_DEFINED" value="18">
+  <tp:enumvalue suffix="RELATION_LAST_DEFINED" value="19">
   <tp:docstring>
     Do not use as a parameter value, used to determine the size of the enumeration. 
   </tp:docstring>
index 5f8ac81..02722c6 100644 (file)
       viewport are included. </p>
   </tp:docstring>
   </tp:property>
-  <tp:property name="caption" type="o" access="read">
+  <tp:property name="caption" type="(so)" access="read">
   <tp:docstring>
     An Accessible which represents of a caption for a Table.
   </tp:docstring>
   </tp:property>
-  <tp:property name="summary" type="o" access="read">
+  <tp:property name="summary" type="(so)" access="read">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
     <p>An accessible object which summarizes the contents of a Table.
       This object is frequently itself a Table instance, albeit a simplified one.</p>
@@ -71,7 +71,7 @@
       The specified table column, zero-indexed.
     </tp:docstring>
     </arg>
-    <arg direction="out" type="o" tp:type="Accessible">
+    <arg direction="out" type="(so)" tp:type="Accessible">
     <tp:docstring>
       An Accessible object representing the specified table cell.
     </tp:docstring>
       The specified table row, zero-indexed.
     </tp:docstring>
     </arg>
-    <arg direction="out" type="o" tp:type="Accessible">
+    <arg direction="out" type="(so)" tp:type="Accessible">
     <tp:docstring>
       An Accessible representatin of the specified table row, if available.
     </tp:docstring>
       The specified table column, zero-indexed.
     </tp:docstring>
     </arg>
-    <arg direction="out" type="o" tp:type="Accessible">
+    <arg direction="out" type="(so)" tp:type="Accessible">
     <tp:docstring>
       An Accessible representatin of the specified table column, if available.
     </tp:docstring>
index 458cdf4..d0d4c7a 100644 (file)
                        </tp:docstring>
                </tp:member>
        
-               <tp:member type="o" tp:name="parent">
+               <tp:member type="(so)" tp:name="parent">
                        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
-                               <p>D-Bus path of the parent accessible.</p>
+                               <p>D-Bus name and path of the parent accessible.</p>
                        </tp:docstring>
                </tp:member>
                
-               <tp:member type="ao" tp:name="children">
+               <tp:member type="a(so)" tp:name="children">
                        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
                                <p>Array of all the child accessibles.</p>
                        </tp:docstring>
@@ -81,7 +81,7 @@
                                application. This should be used to create
                                a mirror of the tree of Accessibles within the AT.</p>
                        </tp:docstring>
-                       <arg name="nodes" type="a(ooaoassusau)" direction="out" tp:type="AccessibleProxy[]">
+                       <arg name="nodes" type="a(o(so)a(so)assusau)" direction="out" tp:type="AccessibleProxy[]">
                                <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
                                        <p>Array of Accessible Object proxy structures.</p>
                                </tp:docstring>
@@ -94,7 +94,7 @@
                                accessible objects that have changed since the last
                                updateTree signal was send</p>
                        </tp:docstring>
-                       <arg name="nodesAdded" type="(ooaoassusau)" tp:type="AccessibleProxy[]">
+                       <arg name="nodesAdded" type="((so)(so)a(so)assusau)" tp:type="AccessibleProxy[]">
                                <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
                                        <p>Array of Accessible Object proxy structures to be added.</p>
                                </tp:docstring>