other-licenses/ia2/AccessibleStates.idl

   1 /*************************************************************************
   2  *
   3  *  File Name (AccessibleStates.idl)
   4  *
   5  *  IAccessible2 IDL Specification
   6  *
   7  *  Copyright (c) IBM Corp. 2007
   8  *  Copyright (c) Sun Microsystems, Inc. 2000, 2006
   9  *
  10  *  This library is free software; you can redistribute it and/or
  11  *  modify it under the terms of the GNU Lesser General Public
  12  *  License version 2.1, as published by the Free Software Foundation; either
  13  *  version 2.1 of the License, or (at your option) any later version.
  14  *
  15  *  This library is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  *  Lesser General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU Lesser General Public
  21  *  License along with this library; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02110-1301  USA
  23  *
  24  ************************************************************************/
  25
  26 import "objidl.idl";
  27
  28 typedef long AccessibleStates;
  29
  30 /** @defgroup grpStates States
  31  IAccessible2 state constants.
  32 */
  33 ///@{
  34
  35 /** Indicates a window is currently the active window. */
  36 const long IA2_STATE_ACTIVE =                                   0x1;
  37
  38 /** Indicates that the object is armed. */
  39 const long IA2_STATE_ARMED =                                    0x2;
  40
  41 /** Indicates the user interface object corresponding to this object no longer exists. */
  42 const long IA2_STATE_DEFUNCT =                                  0x4;
  43
  44 /** Indicates the user can change the contents of this object. */
  45 const long IA2_STATE_EDITABLE =                                 0x8;
  46
  47 /** Indicates the orientation of this object is horizontal. */
  48 const long IA2_STATE_HORIZONTAL =                               0x10;
  49
  50 /** Indicates this object is minimized and is represented only by an icon. */
  51 const long IA2_STATE_ICONIFIED =                                0x20;
  52
  53 /** Indicates an input validation failure. */
  54 const long IA2_STATE_INVALID_ENTRY =                    0x40;
  55
  56 /** Indicates that this object manages its children.
  57
  58  Used when children are transient.  In this case it is not necessary to add
  59   listeners to the children.
  60
  61  The state is added to improve performance in the case of large containers such
  62   as tables. When an object manages its children it is not necessary to iterate
  63   over all the children and add listeners.  The parent object will provide state
  64   notifications regarding the state of its children.
  65 */
  66 const long IA2_STATE_MANAGES_DESCENDANTS =              0x80;
  67
  68 /** Indicates that an object is modal.
  69
  70  Modal objects have the behavior that something must be done with the object
  71   before the user can interact with an object in a different window.
  72 */
  73 const long IA2_STATE_MODAL =                                    0x100;
  74
  75 /** Indicates this text object can contain multiple lines of text. */
  76 const long IA2_STATE_MULTI_LINE =                               0x200;
  77
  78 /** Indicates this object paints every pixel within its rectangular region. */
  79 const long IA2_STATE_OPAQUE =                                   0x400;
  80
  81 /** Indicates that user interaction is required.
  82
  83  An example of when this state is used is when a field in a form must be filled
  84   before a form can be processed.
  85 */
  86 const long IA2_STATE_REQUIRED =                                 0x800;
  87
  88 /** Indicates an object which supports text selection.
  89
  90  Note: This is different than MSAA STATE_SYSTEM_SELECTABLE.
  91 */
  92 const long IA2_STATE_SELECTABLE_TEXT =                  0x1000;
  93
  94 /** Indicates that this text object can contain only a single line of text. */
  95 const long IA2_STATE_SINGLE_LINE =                              0x2000;
  96
  97 /** Indicates that the accessible object is stale.
  98
  99  This state is used when the accessible object no longer accurately
 100   represents the state of the object which it is representing such as when an
 101   object is transient or when an object has been or is in the process of being
 102   destroyed.
 103 */
 104 const long IA2_STATE_STALE =                                    0x4000;
 105
 106 /** Indicates that the object implements autocompletion.
 107
 108  This state indicates that that a text control will respond to the input of
 109  one ore more characters and cause a sub-item to become selected.  The
 110  selection may also result in events fired on the parent object.
 111 */
 112 const long IA2_STATE_SUPPORTS_AUTOCOMPLETION =  0x8000;
 113
 114 /** Indicates this object is transient. */
 115 const long IA2_STATE_TRANSIENT =                                0x10000;
 116
 117 /** Indicates the orientation of this object is vertical. */
 118 const long IA2_STATE_VERTICAL =                                 0x20000;
 119
 120 ///@}