idl/Accessibility_Relation.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_RELATION_IDL
  24 #define _ACCESSIBILITY_RELATION_IDL
  25
  26 module Accessibility {
  27
  28   enum RelationType {
  29     RELATION_NULL,
  30     RELATION_LABEL_FOR,
  31     RELATION_LABELLED_BY,
  32     RELATION_CONTROLLER_FOR,
  33     RELATION_CONTROLLED_BY,
  34     RELATION_MEMBER_OF,
  35     RELATION_TOOLTIP_FOR,
  36     RELATION_NODE_CHILD_OF,
  37     RELATION_EXTENDED,
  38     RELATION_FLOWS_TO,
  39     RELATION_FLOWS_FROM,
  40     RELATION_SUBWINDOW_OF,
  41     RELATION_EMBEDS,
  42     RELATION_EMBEDDED_BY,
  43     RELATION_POPUP_FOR,
  44     RELATION_LAST_DEFINED
  45   };
  46
  47   /*
  48    * This interface inherits from a base class implementing ref counts.
  49    */
  50
  51   interface Relation : Bonobo::Unknown {
  52     RelationType        getRelationType ();
  53     string getRelationTypeName ();
  54     short               getNTargets ();
  55     Object              getTarget (in short index);
  56     /* placeholders for future expansion */
  57     void unImplemented ();
  58     void unImplemented2 ();
  59     void unImplemented3 ();
  60     void unImplemented4 ();
  61   };
  62 };
  63
  64 #endif