accessible/public/nsIAccessibleRelation.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Mozilla Foundation.
  19  * Portions created by the Initial Developer are Copyright (C) 2007
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Alexander Surkov <surkov.alexander@gmail.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40 #include "nsIArray.idl"
  41
  42 interface nsIAccessible;
  43
  44 /**
  45  * This interface gives access to an accessible's set of relations.
  46  * Be carefull, do not change constants until ATK has a structure to map gecko
  47  * constants into ATK constants.
  48  */
  49 [scriptable, uuid(f42a1589-70ab-4704-877f-4a9162bbe188)]
  50 interface nsIAccessibleRelation : nsISupports
  51 {
  52
  53   const unsigned long RELATION_NUL = 0x00;
  54
  55   /**
  56    * Some attribute of this object is affected by a target object.
  57    */
  58   const unsigned long RELATION_CONTROLLED_BY = 0x01;
  59
  60   // First relation
  61   const unsigned long RELATION_FIRST = RELATION_CONTROLLED_BY;
  62
  63   /**
  64    * This object is interactive and controls some attribute of a target object.
  65    */
  66   const unsigned long RELATION_CONTROLLER_FOR = 0x02;
  67
  68   /**
  69    * This object is label for a target object.
  70    */
  71   const unsigned long RELATION_LABEL_FOR = 0x03;
  72
  73   /**
  74    * This object is labelled by a target object.
  75    */
  76   const unsigned long RELATION_LABELLED_BY = 0x04;
  77
  78   /**
  79    * This object is a member of a group of one or more objects. When there is
  80    * more than one object in the group each member may have one and the same
  81    * target, e.g. a grouping object.  It is also possible that each member has
  82    * multiple additional targets, e.g. one for every other member in the group.
  83    */
  84   const unsigned long RELATION_MEMBER_OF = 0x05;
  85
  86   /**
  87    * This object is a child of a target object.
  88    */
  89   const unsigned long RELATION_NODE_CHILD_OF = 0x06;
  90
  91   /**
  92    * Content flows from this object to a target object, i.e. has content that
  93    * flows logically to another object in a sequential way, e.g. text flow.
  94    */
  95   const unsigned long RELATION_FLOWS_TO = 0x07;
  96
  97   /**
  98    * Content flows to this object from a target object, i.e. has content that
  99    * flows logically from another object in a sequential way, e.g. text flow.
 100    */
 101   const unsigned long RELATION_FLOWS_FROM = 0x08;
 102
 103   /**
 104    * This object is a sub window of a target object.
 105    */
 106   const unsigned long RELATION_SUBWINDOW_OF = 0x09;
 107
 108   /**
 109    * This object embeds a target object. This relation can be used on the
 110    * OBJID_CLIENT accessible for a top level window to show where the content
 111    * areas are.
 112    */
 113   const unsigned long RELATION_EMBEDS = 0x0a;
 114
 115   /**
 116    * This object is embedded by a target object.
 117    */
 118   const unsigned long RELATION_EMBEDDED_BY = 0x0b;
 119
 120   /**
 121    * This object is a transient component related to the target object. When
 122    * this object is activated the target object doesn't loose focus.
 123    */
 124   const unsigned long RELATION_POPUP_FOR = 0x0c;
 125
 126   /**
 127    * This object is a parent window of the target object.
 128    */
 129   const unsigned long RELATION_PARENT_WINDOW_OF = 0x0d;
 130
 131   /**
 132    * This object is described by the target object.
 133    */
 134   const unsigned long RELATION_DESCRIBED_BY = 0x0e;
 135
 136   /**
 137    * This object is describes the target object.
 138    */
 139   const unsigned long RELATION_DESCRIPTION_FOR = 0x0f;
 140
 141   // Last relation that is standard to desktop accessibility APIs
 142   const unsigned long RELATION_LAST = RELATION_DESCRIPTION_FOR;
 143
 144   /**
 145    * Part of a form/dialog with a related default button. It is used for
 146    * MSAA only, no for IA2 nor ATK.
 147    */
 148   const unsigned long RELATION_DEFAULT_BUTTON = 0x4000;
 149
 150   /**
 151    * Returns the type of the relation.
 152    */
 153   readonly attribute unsigned long relationType;
 154
 155   /**
 156    * Returns the number of targets for this relation.
 157    */
 158   readonly attribute unsigned long targetsCount;
 159
 160   /**
 161    * Returns one accessible relation target.
 162    * @param index - 0 based index of relation target.
 163    */
 164   nsIAccessible getTarget(in unsigned long index);
 165
 166   /**
 167    * Returns multiple accessible relation targets.
 168    */
 169   nsIArray getTargets();
 170 };