atk/atkstate.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  21 #error "Only <atk/atk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __ATK_STATE_H__
  25 #define __ATK_STATE_H__
  26
  27 #include <glib-object.h>
  28 #include <atk/atkversion.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /**
  33  *AtkStateType:
  34  *@ATK_STATE_INVALID: Indicates an invalid state - probably an error condition.
  35  *@ATK_STATE_ACTIVE: Indicates a window is currently the active window, or an object is the active subelement within a container or table. ATK_STATE_ACTIVE should not be used for objects which have ATK_STATE_FOCUSABLE or ATK_STATE_SELECTABLE: Those objects should use ATK_STATE_FOCUSED and ATK_STATE_SELECTED respectively. ATK_STATE_ACTIVE is a means to indicate that an object which is not focusable and not selectable is the currently-active item within its parent container.
  36  *@ATK_STATE_ARMED: Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds.  Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation. ATK_STATE_ARMED has been deprecated since ATK-2.16 and should not be used in newly-written code.
  37  *@ATK_STATE_BUSY:  Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress.  This state may be used by implementors of Document to indicate that content loading is underway.  It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed.
  38  *@ATK_STATE_CHECKED: Indicates this object is currently checked, for instance a checkbox is 'non-empty'.
  39  *@ATK_STATE_DEFUNCT: Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed)
  40  *@ATK_STATE_EDITABLE: Indicates that this object can contain text, and that the
  41  * user can change the textual contents of this object by editing those contents
  42  * directly. For an object which is expected to be editable due to its type, but
  43  * which cannot be edited due to the application or platform preventing the user
  44  * from doing so, that object's #AtkStateSet should lack ATK_STATE_EDITABLE and
  45  * should contain ATK_STATE_READ_ONLY.
  46  *@ATK_STATE_ENABLED:   Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE
  47  *@ATK_STATE_EXPANDABLE: Indicates this object allows progressive disclosure of its children
  48  *@ATK_STATE_EXPANDED: Indicates this object its expanded - see ATK_STATE_EXPANDABLE above
  49  *@ATK_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
  50  *@ATK_STATE_FOCUSED: Indicates this object currently has the keyboard focus
  51  *@ATK_STATE_HORIZONTAL: Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR.  For objects where vertical/horizontal orientation is especially meaningful.
  52  *@ATK_STATE_ICONIFIED: Indicates this object is minimized and is represented only by an icon
  53  *@ATK_STATE_MODAL: Indicates something must be done with this object before the user can interact with an object in a different window
  54  *@ATK_STATE_MULTI_LINE: Indicates this (text) object can contain multiple lines of text
  55  *@ATK_STATE_MULTISELECTABLE: Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections.
  56  *@ATK_STATE_OPAQUE: Indicates this object paints every pixel within its rectangular region.
  57  *@ATK_STATE_PRESSED: Indicates this object is currently pressed.
  58  *@ATK_STATE_RESIZABLE: Indicates the size of this object is not fixed
  59  *@ATK_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
  60  *@ATK_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
  61  *@ATK_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user interaction.
  62  * STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls,
  63  * but may be found in the absence of STATE_ENABLED if the current visible state of the
  64  * control is "disconnected" from the application state.  In such cases, direct user interaction
  65  * can often result in the object gaining STATE_SENSITIVE, for instance if a user makes
  66  * an explicit selection using an object whose current state is ambiguous or undefined.
  67  * @see STATE_ENABLED, STATE_INDETERMINATE.
  68  *@ATK_STATE_SHOWING: Indicates this object, the object's parent, the object's parent's parent, and so on,
  69  * are all 'shown' to the end-user, i.e. subject to "exposure" if blocking or obscuring objects do not interpose
  70  * between this object and the top of the window stack.
  71  *@ATK_STATE_SINGLE_LINE: Indicates this (text) object can contain only a single line of text
  72  *@ATK_STATE_STALE: Indicates that the information returned for this object may no longer be
  73  * synchronized with the application state.  This is implied if the object has STATE_TRANSIENT,
  74  * and can also occur towards the end of the object peer's lifecycle. It can also be used to indicate that
  75  * the index associated with this object has changed since the user accessed the object (in lieu of
  76  * "index-in-parent-changed" events).
  77  *@ATK_STATE_TRANSIENT: Indicates this object is transient, i.e. a snapshot which may not emit events when its
  78  * state changes.  Data from objects with ATK_STATE_TRANSIENT should not be cached, since there may be no
  79  * notification given when the cached data becomes obsolete.
  80  *@ATK_STATE_VERTICAL: Indicates the orientation of this object is vertical
  81  *@ATK_STATE_VISIBLE: Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.
  82  * @note: STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only
  83  * that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the
  84  * field of view, or having an ancestor container that has not yet made visible.
  85  * A widget is potentially onscreen if it has both STATE_VISIBLE and STATE_SHOWING.
  86  * The absence of STATE_VISIBLE and STATE_SHOWING is semantically equivalent to saying
  87  * that an object is 'hidden'.  See also STATE_TRUNCATED, which applies if a VISIBLE and SHOWING object
  88  * lies within a viewport which means that its contents are clipped, e.g. a truncated spreadsheet cell or
  89  * an image within a scrolling viewport.  Mostly useful for screen-review and magnification algorithms.
  90  *@ATK_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed" event
  91  * is sent when children become 'active' (i.e. are selected or navigated to onscreen).
  92  * Used to prevent need to enumerate all children in very large containers, like tables.
  93  * The presence of STATE_MANAGES_DESCENDANTS is an indication to the client.
  94  * that the children should not, and need not, be enumerated by the client.
  95  * Objects implementing this state are expected to provide relevant state
  96  * notifications to listening clients, for instance notifications of visibility
  97  * changes and activation of their contained child objects, without the client
  98  * having previously requested references to those children.
  99  *@ATK_STATE_INDETERMINATE: Indicates that the value, or some other quantifiable
 100  * property, of this AtkObject cannot be fully determined. In the case of a large
 101  * data set in which the total number of items in that set is unknown (e.g. 1 of
 102  * 999+), implementors should expose the currently-known set size (999) along
 103  * with this state. In the case of a check box, this state should be used to
 104  * indicate that the check box is a tri-state check box which is currently
 105  * neither checked nor unchecked.
 106  *@ATK_STATE_TRUNCATED: Indicates that an object is truncated, e.g. a text value in a speradsheet cell.
 107  *@ATK_STATE_REQUIRED: Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface.
 108  *@ATK_STATE_INVALID_ENTRY: Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input.
 109  *@ATK_STATE_SUPPORTS_AUTOCOMPLETION:  Indicates that the object in question implements some form of ¨typeahead¨ or
 110  * pre-selection behavior whereby entering the first character of one or more sub-elements
 111  * causes those elements to scroll into view or become selected.  Subsequent character input
 112  * may narrow the selection further as long as one or more sub-elements match the string.
 113  * This state is normally only useful and encountered on objects that implement Selection.
 114  * In some cases the typeahead behavior may result in full or partial ¨completion¨ of
 115  * the data in the input field, in which case these input events may trigger text-changed
 116  * events from the AtkText interface.  This state supplants @ATK_ROLE_AUTOCOMPLETE.
 117  *@ATK_STATE_SELECTABLE_TEXT:Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from @ATK_STATE_SELECTABLE, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations.
 118  *@ATK_STATE_DEFAULT: Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key.  Typically a "close" or "submit" button.
 119  *@ATK_STATE_ANIMATED: Indicates that the object changes its appearance dynamically as an inherent part of its presentation.  This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation.
 120  * @note some applications, notably content viewers, may not be able to detect
 121  * all kinds of animated content.  Therefore the absence of this state should not
 122  * be taken as definitive evidence that the object's visual representation is
 123  * static; this state is advisory.
 124  *@ATK_STATE_VISITED: Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited".
 125  *@ATK_STATE_CHECKABLE: Indicates this object has the potential to be
 126  *  checked, such as a checkbox or toggle-able table cell. @Since:
 127  *  ATK-2.12
 128  *@ATK_STATE_HAS_POPUP: Indicates that the object has a popup context
 129  * menu or sub-level menu which may or may not be showing. This means
 130  * that activation renders conditional content.  Note that ordinary
 131  * tooltips are not considered popups in this context. @Since: ATK-2.12
 132  *@ATK_STATE_HAS_TOOLTIP: Indicates this object has a tooltip. @Since: ATK-2.16
 133  *@ATK_STATE_READ_ONLY: Indicates that a widget which is ENABLED and SENSITIVE
 134  * has a value which can be read, but not modified, by the user. Note that this
 135  * state should only be applied to widget types whose value is normally directly
 136  * user modifiable, such as check boxes, radio buttons, spin buttons, text input
 137  * fields, and combo boxes, as a means to convey that the expected interaction
 138  * with that widget is not possible. When the expected interaction with a
 139  * widget does not include modification by the user, as is the case with
 140  * labels and containers, ATK_STATE_READ_ONLY should not be applied. See also
 141  * ATK_STATE_EDITABLE. @Since: ATK-2-16
 142  *@ATK_STATE_LAST_DEFINED: Not a valid state, used for finding end of enumeration
 143  *
 144  *The possible types of states of an object
 145  **/
 146 typedef enum
 147 {
 148   ATK_STATE_INVALID,
 149   ATK_STATE_ACTIVE,
 150   ATK_STATE_ARMED,
 151   ATK_STATE_BUSY,
 152   ATK_STATE_CHECKED,
 153   ATK_STATE_DEFUNCT,
 154   ATK_STATE_EDITABLE,
 155   ATK_STATE_ENABLED,
 156   ATK_STATE_EXPANDABLE,
 157   ATK_STATE_EXPANDED,
 158   ATK_STATE_FOCUSABLE,
 159   ATK_STATE_FOCUSED,
 160   ATK_STATE_HORIZONTAL,
 161   ATK_STATE_ICONIFIED,
 162   ATK_STATE_MODAL,
 163   ATK_STATE_MULTI_LINE,
 164   ATK_STATE_MULTISELECTABLE,
 165   ATK_STATE_OPAQUE,
 166   ATK_STATE_PRESSED,
 167   ATK_STATE_RESIZABLE,
 168   ATK_STATE_SELECTABLE,
 169   ATK_STATE_SELECTED,
 170   ATK_STATE_SENSITIVE,
 171   ATK_STATE_SHOWING,
 172   ATK_STATE_SINGLE_LINE,
 173   ATK_STATE_STALE,
 174   ATK_STATE_TRANSIENT,
 175   ATK_STATE_VERTICAL,
 176   ATK_STATE_VISIBLE,
 177   ATK_STATE_MANAGES_DESCENDANTS,
 178   ATK_STATE_INDETERMINATE,
 179   ATK_STATE_TRUNCATED,
 180   ATK_STATE_REQUIRED,
 181   ATK_STATE_INVALID_ENTRY,
 182   ATK_STATE_SUPPORTS_AUTOCOMPLETION,
 183   ATK_STATE_SELECTABLE_TEXT,
 184   ATK_STATE_DEFAULT,
 185   ATK_STATE_ANIMATED,
 186   ATK_STATE_VISITED,
 187   ATK_STATE_CHECKABLE,
 188   ATK_STATE_HAS_POPUP,
 189   ATK_STATE_HAS_TOOLTIP,
 190   ATK_STATE_READ_ONLY,
 191   ATK_STATE_HIGHLIGHTED,
 192   ATK_STATE_HIGHLIGHTABLE,
 193   ATK_STATE_LAST_DEFINED
 194 } AtkStateType;
 195
 196 typedef guint64      AtkState;
 197
 198 ATK_AVAILABLE_IN_ALL
 199 AtkStateType atk_state_type_register            (const gchar *name);
 200
 201 ATK_AVAILABLE_IN_ALL
 202 const gchar*          atk_state_type_get_name   (AtkStateType type);
 203 ATK_AVAILABLE_IN_ALL
 204 AtkStateType          atk_state_type_for_name   (const gchar  *name);
 205
 206 G_END_DECLS
 207
 208 #endif /* __ATK_STATE_H__ */