cspi/spi-statetypes.h

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2002 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 Ximian, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef _SPI_STATETYPES_H_
  25 #define _SPI_STATETYPES_H_
  26
  27 #ifdef  __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /**
  32  *AccessibleState:
  33  *@SPI_STATE_INVALID: Indicates an invalid state
  34  *@SPI_STATE_ACTIVE: Indicates a window is currently the active window
  35  *@SPI_STATE_ARMED: Indicates that the object is armed
  36  *@SPI_STATE_BUSY: Indicates the current object is busy
  37  *@SPI_STATE_CHECKED: Indicates this object is currently checked
  38  *@SPI_STATE_COLLAPSED: Indicates this object is collapsed
  39  *@SPI_STATE_DEFUNCT: Indicates the user interface object corresponding to this object no longer exists
  40  *@SPI_STATE_EDITABLE: Indicates the user can change the contents of this object
  41  *@SPI_STATE_ENABLED: Indicates that this object is enabled
  42  *@SPI_STATE_EXPANDABLE: Indicates this object allows progressive disclosure of its children
  43  *@SPI_STATE_EXPANDED: Indicates this object its expanded
  44  *@SPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus
  45  *@SPI_STATE_FOCUSED: Indicates this object currently has the keyboard focus
  46  *@SPI_STATE_HORIZONTAL: Indicates the orientation of thsi object is horizontal
  47  *@SPI_STATE_ICONIFIED: Indicates this object is minimized and is represented only by an icon
  48  *@SPI_STATE_MODAL: Indicates something must be done with this object before the user can interact with an object in a different window
  49  *@SPI_STATE_MULTI_LINE: Indicates this (text) object can contain multiple lines of text
  50  *@SPI_STATE_MULTISELECTABLE: Indicates this object allows more than one of its children to be selected at the same time
  51  *@SPI_STATE_OPAQUE: Indicates this object paints every pixel within its rectangular region
  52  *@SPI_STATE_PRESSED: Indicates this object is currently pressed
  53  *@SPI_STATE_RESIZABLE: Indicates the size of this object is not fixed
  54  *@SPI_STATE_SELECTABLE: Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected
  55  *@SPI_STATE_SELECTED: Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected
  56  *@SPI_STATE_SENSITIVE: Indicates this object is sensitive
  57  *@SPI_STATE_SHOWING: Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible
  58  *@SPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only a single line of text
  59  *@SPI_STATE_STALE: Indicates that the index associated with this object has changed since the user accessed the object
  60  *@SPI_STATE_TRANSIENT: Indicates this object is transient
  61  *@SPI_STATE_VERTICAL: Indicates the orientation of this object is vertical
  62  *@SPI_STATE_VISIBLE: Indicates this object is visible
  63  *@SPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed"
  64  * event is sent when children become 'active' (i.e. are selected or navigated
  65  * to onscreen).  Used to prevent need to enumerate all children in very large
  66  * containers, like tables.
  67  *@SPI_STATE_LAST_DEFINED: Not a valid state, used for finding end of enumeration
  68  *
  69  *The possibles states of an object.
  70  **/
  71 typedef enum
  72 {
  73   SPI_STATE_INVALID,
  74   SPI_STATE_ACTIVE,
  75   SPI_STATE_ARMED,
  76   SPI_STATE_BUSY,
  77   SPI_STATE_CHECKED,
  78   SPI_STATE_COLLAPSED,
  79   SPI_STATE_DEFUNCT,
  80   SPI_STATE_EDITABLE,
  81   SPI_STATE_ENABLED,
  82   SPI_STATE_EXPANDABLE,
  83   SPI_STATE_EXPANDED,
  84   SPI_STATE_FOCUSABLE,
  85   SPI_STATE_FOCUSED,
  86   SPI_STATE_HORIZONTAL,
  87   SPI_STATE_ICONIFIED,
  88   SPI_STATE_MODAL,
  89   SPI_STATE_MULTI_LINE,
  90   SPI_STATE_MULTISELECTABLE,
  91   SPI_STATE_OPAQUE,
  92   SPI_STATE_PRESSED,
  93   SPI_STATE_RESIZABLE,
  94   SPI_STATE_SELECTABLE,
  95   SPI_STATE_SELECTED,
  96   SPI_STATE_SENSITIVE,
  97   SPI_STATE_SHOWING,
  98   SPI_STATE_SINGLE_LINE,
  99   SPI_STATE_STALE,
 100   SPI_STATE_TRANSIENT,
 101   SPI_STATE_VERTICAL,
 102   SPI_STATE_VISIBLE,
 103   SPI_STATE_MANAGES_DESCENDANTS,
 104   SPI_STATE_LAST_DEFINED
 105 } AccessibleState;
 106
 107 #ifdef  __cplusplus
 108 }
 109 #endif
 110
 111 #endif