# Accessibility_Collection.idl

Go to the documentation of this file.

    00001  /*
    00002   * AT-SPI - Assistive Technology Service Provider Interface
    00003   * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
    00004   *
    00005   * Copyright 2005 Sun Microsystems, Inc.
    00006   *
    00007   * This library is free software; you can redistribute it and/or
    00008   * modify it under the terms of the GNU Library General Public
    00009   * License as published by the Free Software Foundation; either
    00010   * version 2 of the License, or (at your option) any later version.
    00011   *
    00012   * This library is distributed in the hope that it will be useful,
    00013   * but WITHOUT ANY WARRANTY; without even the implied warranty of
    00014   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00015   * Library General Public License for more details.
    00016   *
    00017   * You should have received a copy of the GNU Library General Public
    00018   * License along with this library; if not, write to the
    00019   * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    00020   * Boston, MA 02111-1307, USA.
    00021   */
    00022
    00023 #ifndef __ACCESSIBILITY_COLLECTION_DEFINED__
    00024 #define __ACCESSIBILITY_COLLECTION_DEFINED__
    00025
    00026 module Accessibility {
    00027
    00028
    00029   typedef sequence<Accessible> AccessibleSet;
    00030
    00031
    00032      interface MatchRule {
    00033      };
    00034
    00035
    00036      interface Collection : Bonobo::Unknown {
    00037
    00038        enum SortOrder {
    00039             SORT_ORDER_INVALID,
    00040             SORT_ORDER_CANONICAL,
    00041             SORT_ORDER_FLOW,
    00042             SORT_ORDER_TAB,
    00043             SORT_ORDER_REVERSE_CANONICAL,
    00044             SORT_ORDER_REVERSE_FLOW,
    00045             SORT_ORDER_REVERSE_TAB,
    00046             SORT_ORDER_LAST_DEFINED
    00047        };
    00048
    00049        enum MatchType {
    00050            MATCH_INVALID,
    00051            MATCH_ALL,
    00052            MATCH_ANY,
    00053            MATCH_NONE,
    00054            MATCH_EMPTY,
    00055            MATCH_LAST_DEFINED
    00056            };
    00057
    00058        enum TreeTraversalType {
    00059
    00060          TREE_RESTRICT_CHILDREN,
    00061          TREE_RESTRICT_SIBLING,
    00062          TREE_INORDER,
    00063          TREE_LAST_DEFINED
    00064        };
    00065
    00066         boolean isAncestorOf (in Accessible object);
    00067
    00068         MatchRule        createMatchRule (in StateSet states,
    00069                                           in MatchType statematchtype,
    00070                                           in AttributeSet attributes,
    00071                                           in MatchType attributematchtype,
    00072                                           in RoleSet roles,
    00073                                           in MatchType rolematchtype,
    00074                                           in string interfaces,
    00075                                           in MatchType interfacematchtype,
    00076                                           in boolean invert);
    00077
    00078         void             freeMatchRule (in MatchRule rule);
    00079
    00080         AccessibleSet getMatches (in MatchRule rule,
    00081                                   in SortOrder sortby,
    00082                                   in long count,
    00083                                   in boolean traverse);
    00084
    00085         AccessibleSet getMatchesTo (in Accessible current_object,
    00086                                     in MatchRule rule,
    00087                                     in SortOrder sortby,
    00088                                     in TreeTraversalType tree,
    00089                                     in boolean recurse,
    00090                                     in long count,
    00091                                     in boolean traverse);
    00092
    00093
    00094         AccessibleSet getMatchesFrom (in Accessible current_object,
    00095                                       in MatchRule rule,
    00096                                       in SortOrder sortby,
    00097                                       in TreeTraversalType tree,
    00098                                       in long count,
    00099                                       in boolean traverse);
    00100
    00101         Accessible getActiveDescendant ();
    00102
    00103         void unImplemented ();
    00104         void unImplemented2 ();
    00105         void unImplemented3 ();
    00106         void unImplemented4 ();
    00107    };
    00108 };
    00109
    00110 #endif