2009-06-11 Mark Doffman <mark.doffman@codethink.co.uk>
[platform/core/uifw/at-spi2-atk.git] / idl / Accessibility_Collection.idl
index 738755e..5f23f63 100644 (file)
 #define __ACCESSIBILITY_COLLECTION_DEFINED__
  
 module Accessibility {
+  
 
-struct AccessibleSetEntry {
-         Accessible accessible;
-         string     name;
-         Role       role;
-};
+  typedef sequence<Accessible> AccessibleSet;
 
-typedef sequence<AccessibleSetEntry> AccessibleSet;
  
      interface MatchRule {
      };
@@ -59,6 +55,13 @@ typedef sequence<AccessibleSetEntry> AccessibleSet;
            MATCH_LAST_DEFINED
           };
 
+       enum TreeTraversalType {
+        
+        TREE_RESTRICT_CHILDREN,
+        TREE_RESTRICT_SIBLING,
+        TREE_INORDER,
+        TREE_LAST_DEFINED
+       };
 
        boolean isAncestorOf (in Accessible object); 
   
@@ -74,23 +77,26 @@ typedef sequence<AccessibleSetEntry> AccessibleSet;
 
        void             freeMatchRule (in MatchRule rule);
 
-       AccessibleSet getChildren (in MatchRule rule,
-                                   in SortOrder sortby,
-                                  in boolean recurse,
-                                   inout long count); /* inOut not accepted */
-
-       AccessibleSet getPreviousChildren (in Accessible current_object,
-                                           in MatchRule rule, 
-                                           in SortOrder sortby, 
-                                           in boolean recurse,
-                                           inout long count);
+       AccessibleSet getMatches (in MatchRule rule,
+                                  in SortOrder sortby,
+                                 in long count,
+                                  in boolean traverse); 
+       
+       AccessibleSet getMatchesTo (in Accessible current_object,
+                                   in MatchRule rule, 
+                                   in SortOrder sortby,
+                                   in TreeTraversalType tree,
+                                   in boolean recurse,
+                                   in long count,
+                                   in boolean traverse);
 
 
-        AccessibleSet getNextChildren (in Accessible current_object,
-                                      in MatchRule rule, 
-                                       in SortOrder sortby, 
-                                       in boolean recurse,
-                                       inout long count);
+        AccessibleSet getMatchesFrom (in Accessible current_object,
+                                     in MatchRule rule, 
+                                     in SortOrder sortby, 
+                                     in TreeTraversalType tree,
+                                     in long count,
+                                     in boolean traverse);
 
         Accessible getActiveDescendant ();