idl/collection.didl

   1
   2 /* TODO - Need to define the 'MatchRule' struct. */
   3
   4 namespace org.freestandards.atspi {
   5         interface Collection {
   6                 enum <uint32> SortOrder {
   7                         SORT_ORDER_INVALID = 0,
   8                         SORT_ORDER_CANONICAL,
   9                         SORT_ORDER_FLOW,
  10                         SORT_ORDER_TAB,
  11                         SORT_ORDER_REVERSE_CANONICAL,
  12                         SORT_ORDER_REVERSE_FLOW,
  13                         SORT_ORDER_REVERSE_TAB,
  14                         SORT_ORDER_LAST_DEFINED
  15                 }
  16
  17                 enum <uint32> MatchType {
  18                         MATCH_INVALID = 0,
  19                         MATCH_ALL,
  20                         MATCH_ANY,
  21                         MATCH_NONE,
  22                         MATCH_EMPTY,
  23                         MATCH_LAST_DEFINED
  24                 }
  25
  26                 enum <uint32> TreeTraversalType {
  27                         TREE_RESTRICT_CHILDREN,
  28                         TREE_RESTRICT_SIBLING,
  29                         TREE_INORDER,
  30                         TREE_LAST_DEFINED
  31                 }
  32
  33                 method GetMatches {
  34                         MatchRule rule;
  35                         SortOrder sort_by;
  36                         int32     count;
  37                         boolean   traverse;
  38                 } reply {
  39                         Reference matches [];
  40                 }
  41
  42                 method GetMatchesTo {
  43                         object    current_object;
  44                         MatchRule rule;
  45                         SortOrder sort_by;
  46                         TreeTraversalType type;
  47                         boolean   recurse;
  48                         int32     count;
  49                         boolean   traverse;
  50                 } reply {
  51                         Reference matches [];
  52                 }
  53
  54                 method GetMatchesFrom {
  55                         object    current_object;
  56                         MatchRule rule;
  57                         SortOrder sort_by;
  58                         TreeTraversalType type;
  59                         int32     count;
  60                         boolean   traverse;
  61                 } reply {
  62                         Reference matches [];
  63                 }
  64
  65                 method GetActiveDescendent reply {
  66                         Reference descendent;
  67                 }
  68         }
  69 }