accessible/public/nsIAccessibleStates.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>
  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
  41 [scriptable, uuid(7fe1ee90-edaa-43f1-9f3b-071099b51f08)]
  42 interface nsIAccessibleStates : nsISupports
  43 {
  44   /**
  45    * MSAA State flags - used for bitfield. More than 1 allowed.
  46    */
  47   const unsigned long  STATE_UNAVAILABLE        = 0x00000001;  // Disabled, maps to opposite of Java ENABLED, Gnome/ATK SENSITIVE?
  48   const unsigned long  STATE_SELECTED           = 0x00000002;
  49   const unsigned long  STATE_FOCUSED            = 0x00000004;
  50   const unsigned long  STATE_PRESSED            = 0x00000008;
  51   const unsigned long  STATE_CHECKED            = 0x00000010;
  52   const unsigned long  STATE_MIXED              = 0x00000020; // 3-state checkbox or toolbar button
  53   const unsigned long  STATE_READONLY           = 0x00000040; // Maps to opposite of Java/Gnome/ATK EDITABLE state
  54   const unsigned long  STATE_HOTTRACKED         = 0x00000080;
  55   const unsigned long  STATE_DEFAULT            = 0x00000100;
  56   const unsigned long  STATE_EXPANDED           = 0x00000200;
  57   const unsigned long  STATE_COLLAPSED          = 0x00000400;
  58   const unsigned long  STATE_BUSY               = 0x00000800;
  59   const unsigned long  STATE_FLOATING           = 0x00001000;  // Children "owned" not "contained" by parent
  60   const unsigned long  STATE_MARQUEED           = 0x00002000;
  61   const unsigned long  STATE_ANIMATED           = 0x00004000;
  62   const unsigned long  STATE_INVISIBLE          = 0x00008000;  // Programatically hidden
  63   const unsigned long  STATE_OFFSCREEN          = 0x00010000;  // Scrolled off
  64   const unsigned long  STATE_SIZEABLE           = 0x00020000;
  65   const unsigned long  STATE_MOVEABLE           = 0x00040000;
  66   const unsigned long  STATE_SELFVOICING        = 0x00080000;
  67   const unsigned long  STATE_FOCUSABLE          = 0x00100000;
  68   const unsigned long  STATE_SELECTABLE         = 0x00200000;
  69   const unsigned long  STATE_LINKED             = 0x00400000;
  70   const unsigned long  STATE_TRAVERSED          = 0x00800000;
  71   const unsigned long  STATE_MULTISELECTABLE    = 0x01000000;  // Supports multiple selection
  72   const unsigned long  STATE_EXTSELECTABLE      = 0x02000000;  // Supports extended selection
  73   const unsigned long  STATE_ALERT_LOW          = 0x04000000;  // This information is of low priority
  74   const unsigned long  STATE_ALERT_MEDIUM       = 0x08000000;  // This information is of medium priority
  75   const unsigned long  STATE_ALERT_HIGH         = 0x10000000;  // This information is of high priority
  76   const unsigned long  STATE_PROTECTED          = 0x20000000;  // Maps to Gnome's *Role* ATK_ROLE_PASSWD_TEXT, nothing for Java?
  77   const unsigned long  STATE_HASPOPUP           = 0x40000000;  // New in MSAA 2.0
  78
  79   // Mapping important states that we don't have to unused alert states on MSAA
  80   // as per discussions with AT vendors. On ATK there will be legitimate states for
  81   // STATE_REQUIRED AND STATE_INVALID
  82   const unsigned long  STATE_REQUIRED           = STATE_ALERT_LOW;
  83   const unsigned long  STATE_IMPORTANT          = STATE_ALERT_MEDIUM; // Not currently used
  84   const unsigned long  STATE_INVALID            = STATE_ALERT_HIGH;
  85   const unsigned long  STATE_CHECKABLE          = STATE_MARQUEED;
  86
  87 /**
  88  * Extended state flags (for now non-MSAA, for Java and Gnome/ATK support)
  89  * "Extended state flags" has separate value space from "MSAA State flags".
  90  */
  91   const unsigned long  EXT_STATE_SUPPORTS_AUTOCOMPLETION = 0x00000001;  // For editable areas that have any kind of autocompletion
  92   const unsigned long  EXT_STATE_DEFUNCT                 = 0x00000002;  // Object no longer exists
  93   const unsigned long  EXT_STATE_SELECTABLE_TEXT         = 0x00000004;  // For text which is selectable, object must implement nsIAccessibleText
  94   const unsigned long  EXT_STATE_EDITABLE                = 0x00000008;  // Implements nsIAccessibleEditableText
  95   const unsigned long  EXT_STATE_ACTIVE                  = 0x00000010;  // This window is currently the active window
  96   const unsigned long  EXT_STATE_MODAL                   = 0x00000020;  // Must do something with control before leaving it
  97   const unsigned long  EXT_STATE_MULTI_LINE              = 0x00000040;  // Edit control that can take multiple lines
  98   const unsigned long  EXT_STATE_HORIZONTAL              = 0x00000080;  // Uses horizontal layout
  99   const unsigned long  EXT_STATE_OPAQUE                  = 0x00000100;  // Indicates this object paints every pixel within its rectangular region.
 100   const unsigned long  EXT_STATE_SINGLE_LINE             = 0x00000200;  // This text object can only contain 1 line of text
 101   const unsigned long  EXT_STATE_TRANSIENT               = 0x00000400;  //
 102   const unsigned long  EXT_STATE_VERTICAL                = 0x00000800;  // Especially used for sliders and scrollbars
 103   const unsigned long  EXT_STATE_STALE                   = 0x00001000;  // Object not dead, but not up-to-date either
 104   const unsigned long  EXT_STATE_ENABLED                 = 0x00002000;  // A widget that is not unavailable
 105   const unsigned long  EXT_STATE_SENSITIVE               = 0x00004000;  // Same as ENABLED for now
 106   const unsigned long  EXT_STATE_EXPANDABLE              = 0x00008000;  // If COLLAPSED or EXPANDED
 107 };
 108