- Main Page
- Namespaces
- Data Structures
- Files
- Directories

- File List
- Globals

# 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 struct AccessibleSetEntry {
    00029          Accessible accessible;
    00030          string     name;
    00031          Role       role;
    00032 };
    00033
    00034 typedef sequence<AccessibleSetEntry> AccessibleSet;
    00035
    00036      interface MatchRule {
    00037      };
    00038
    00039
    00040      interface Collection : Bonobo::Unknown {
    00041
    00042        enum SortOrder {
    00043             SORT_ORDER_INVALID,
    00044             SORT_ORDER_CANONICAL,
    00045             SORT_ORDER_FLOW,
    00046             SORT_ORDER_TAB,
    00047             SORT_ORDER_REVERSE_CANONICAL,
    00048             SORT_ORDER_REVERSE_FLOW,
    00049             SORT_ORDER_REVERSE_TAB,
    00050             SORT_ORDER_LAST_DEFINED
    00051        };
    00052
    00053        enum MatchType {
    00054            MATCH_INVALID,
    00055            MATCH_ALL,
    00056            MATCH_ANY,
    00057            MATCH_NONE,
    00058            MATCH_EMPTY,
    00059            MATCH_LAST_DEFINED
    00060            };
    00061
    00062
    00063         boolean isAncestorOf (in Accessible object);
    00064
    00065         MatchRule        createMatchRule (in StateSet states,
    00066                                           in MatchType statematchtype,
    00067                                           in AttributeSet attributes,
    00068                                           in MatchType attributematchtype,
    00069                                           in RoleSet roles,
    00070                                           in MatchType rolematchtype,
    00071                                           in string interfaces,
    00072                                           in MatchType interfacematchtype,
    00073                                           in boolean invert);
    00074
    00075         void             freeMatchRule (in MatchRule rule);
    00076
    00077         AccessibleSet getChildren (in MatchRule rule,
    00078                                    in SortOrder sortby,
    00079                                    in boolean recurse,
    00080                                    inout long count); /* inOut not accepted */
    00081
    00082         AccessibleSet getPreviousChildren (in Accessible current_object,
    00083                                            in MatchRule rule,
    00084                                            in SortOrder sortby,
    00085                                            in boolean recurse,
    00086                                            inout long count);
    00087
    00088
    00089         AccessibleSet getNextChildren (in Accessible current_object,
    00090                                        in MatchRule rule,
    00091                                        in SortOrder sortby,
    00092                                        in boolean recurse,
    00093                                        inout long count);
    00094
    00095         Accessible getActiveDescendant ();
    00096
    00097         void unImplemented ();
    00098         void unImplemented2 ();
    00099         void unImplemented3 ();
    00100         void unImplemented4 ();
    00101    };
    00102 };
    00103
    00104 #endif