idl/Accessibility_Accessible.idl

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001 Sun Microsystems Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifndef _ACCESSIBILITY_ACCESSIBLE_IDL
  24 #define _ACCESSIBILITY_ACCESSIBLE_IDL
  25
  26 #include <Bonobo_Unknown.idl>
  27
  28 #include "Relation.idl"
  29 #include "State.idl"
  30 #include "Role.idl"
  31
  32 module Accessibility {
  33
  34   typedef sequence<Relation> RelationSet;
  35   exception ChildGone {} ;
  36
  37   struct BoundingBox {
  38           long x;
  39           long y;
  40           long width;
  41           long height;
  42   };
  43
  44   interface Accessible : Bonobo::Unknown {
  45
  46     /**
  47      * @name: a (short) #string representing the object's name.
  48      **/
  49     attribute string name;
  50
  51     /**
  52      * @description: a #string describing the object in more detail than @name.
  53      **/
  54     attribute string description;
  55
  56     /**
  57      * @parent: an #Accessible object which is this object's containing object.
  58      **/
  59     readonly attribute Accessible parent;
  60
  61     /**
  62      * @childCount: the number of children contained by this object.
  63      **/
  64     readonly attribute long     childCount;
  65
  66     /**
  67      * isEqual:
  68      * @obj: an #Accessible object reference to compare to
  69      *
  70      * Determine whether an #Accessible refers to the same object as another
  71      *
  72      * Returns: a #boolean indicating whether the two object references
  73      *         point to the same object.
  74      **/
  75     boolean isEqual (in Accessible obj);
  76
  77     /**
  78      * getChildAtIndex:
  79      * @index: an in parameter indicating which child is requested (zero-indexed).
  80      *
  81      * Get the accessible child of this object at index @index.
  82      *
  83      * Returns: the 'nth' @Accessible child of this object.
  84      **/
  85     Accessible  getChildAtIndex (in long index)
  86             raises (ChildGone);
  87
  88     /**
  89      * getIndexInParent:
  90      *
  91      * Get the index of this object in its parent's child list.
  92      *
  93      * Returns: a long integer indicating this object's index in the parent's list.
  94      **/
  95     long                getIndexInParent ();
  96
  97     /**
  98      * getRelationSet:
  99      *
 100      * Get a set defining this object's relationship to other accessible objects.
 101      *
 102      * Returns: a @RelationSet defining this object's relationships.
 103      **/
 104     RelationSet getRelationSet ();
 105
 106     /**
 107      * getRole:
 108      * Get the @Role indicating the type of UI role played by this object.
 109      *
 110      * Returns: a @Role indicating the type of UI role played by this object.
 111      **/
 112     Role                getRole ();
 113
 114     /**
 115      * getState:
 116      *
 117      * Get the current state of the object as a @StateSet.
 118      * Returns: a @StateSet encapsulating the currently true states of the object.
 119      **/
 120     StateSet    getState ();
 121   };
 122 };
 123
 124 #endif
 125