xml/Accessibility_State.xml

   1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   2
   3 <tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
   4 <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
   5 <tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
   6 <tp:license xmlns="http://www.w3.org/1999/xhtml">
   7   <p>This library is free software; you can redistribute it and/or
   8     modify it under the terms of the GNU Library General Public
   9     License as published by the Free Software Foundation; either
  10     version 2 of the License, or (at your option) any later version.</p>
  11
  12   <p>This library is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15     Library General Public License for more details.</p>
  16
  17   <p>You should have received a copy of the GNU Library General Public
  18     License along with this library; if not, write to the
  19     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20     Boston, MA 02111-1307, USA.</p>
  21 </tp:license>
  22 <tp:enum name="StateType" type="u">
  23   <tp:enumvalue suffix="STATE_INVALID"/>
  24   <tp:enumvalue suffix="STATE_ACTIVE" value="1">
  25   <tp:docstring>
  26     Indicates a window is currently the active window, or is an active subelement within a container or table
  27   </tp:docstring>
  28   </tp:enumvalue>
  29   <tp:enumvalue suffix="STATE_ARMED" value="2">
  30   <tp:docstring>
  31     Indicates that the object is armed
  32   </tp:docstring>
  33   </tp:enumvalue>
  34   <tp:enumvalue suffix="STATE_BUSY" value="3">
  35   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  36     <p>Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or
  37       the object is temporarily unavailable for interaction due to activity already in progress.</p>
  38   </tp:docstring>
  39   </tp:enumvalue>
  40   <tp:enumvalue suffix="STATE_CHECKED" value="4">
  41   <tp:docstring>
  42     Indicates this object is currently checked
  43   </tp:docstring>
  44   </tp:enumvalue>
  45   <tp:enumvalue suffix="STATE_COLLAPSED" value="5">
  46   <tp:docstring>
  47     Indicates this object is collapsed
  48   </tp:docstring>
  49   </tp:enumvalue>
  50   <tp:enumvalue suffix="STATE_DEFUNCT" value="6">
  51   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  52     <p>Indicates that this object no longer has a valid backing widget
  53       (for instance, if its peer object has been destroyed) </p>
  54   </tp:docstring>
  55   </tp:enumvalue>
  56   <tp:enumvalue suffix="STATE_EDITABLE" value="7">
  57   <tp:docstring>
  58     Indicates the user can change the contents of this object
  59   </tp:docstring>
  60   </tp:enumvalue>
  61   <tp:enumvalue suffix="STATE_ENABLED" value="8">
  62   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  63     <p>Indicates that this object is enabled, i.e. that it currently reflects some application state.
  64       Objects that are &quot;greyed out&quot; may lack this state, and may lack the STATE_SENSITIVE if direct user
  65       interaction cannot cause them to acquire STATE_ENABLED.  @see STATE_SENSITIVE.</p>
  66   </tp:docstring>
  67   </tp:enumvalue>
  68   <tp:enumvalue suffix="STATE_EXPANDABLE" value="9">
  69   <tp:docstring>
  70     Indicates this object allows progressive disclosure of its children
  71   </tp:docstring>
  72   </tp:enumvalue>
  73   <tp:enumvalue suffix="STATE_EXPANDED" value="10">
  74   <tp:docstring>
  75     Indicates this object its expanded
  76   </tp:docstring>
  77   </tp:enumvalue>
  78   <tp:enumvalue suffix="STATE_FOCUSABLE" value="11">
  79   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  80     <p>Indicates this object can accept keyboard focus, which means all
  81       events resulting from typing on the keyboard will normally be passed
  82       to it when it has focus</p>
  83   </tp:docstring>
  84   </tp:enumvalue>
  85   <tp:enumvalue suffix="STATE_FOCUSED" value="12">
  86   <tp:docstring>
  87     Indicates this object currently has the keyboard focus
  88   </tp:docstring>
  89   </tp:enumvalue>
  90   <tp:enumvalue suffix="STATE_HAS_TOOLTIP" value="13">
  91   <tp:docstring>
  92     Indicates that the object has an associated tooltip
  93   </tp:docstring>
  94   </tp:enumvalue>
  95   <tp:enumvalue suffix="STATE_HORIZONTAL" value="14">
  96   <tp:docstring>
  97     Indicates the orientation of thsi object is horizontal
  98   </tp:docstring>
  99   </tp:enumvalue>
 100   <tp:enumvalue suffix="STATE_ICONIFIED" value="15">
 101   <tp:docstring>
 102     Indicates this object is minimized and is represented only by an icon
 103   </tp:docstring>
 104   </tp:enumvalue>
 105   <tp:enumvalue suffix="STATE_MODAL" value="16">
 106   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 107     <p>Indicates something must be done with this object before the user can
 108       interact with an object in a different window.</p>
 109   </tp:docstring>
 110   </tp:enumvalue>
 111   <tp:enumvalue suffix="STATE_MULTI_LINE" value="17">
 112   <tp:docstring>
 113     Indicates this (text) object can contain multiple lines of text
 114   </tp:docstring>
 115   </tp:enumvalue>
 116   <tp:enumvalue suffix="STATE_MULTISELECTABLE" value="18">
 117   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 118     <p>Indicates this object allows more than one of its children to be
 119       selected at the same time, or in the case of text objects,
 120       that the object supports non-contiguous text selections.</p>
 121   </tp:docstring>
 122   </tp:enumvalue>
 123   <tp:enumvalue suffix="STATE_OPAQUE" value="19">
 124   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 125     <p>Indicates this object paints every pixel within its rectangular region.
 126       It also indicates an alpha value of unity, if it supports alpha blending. </p>
 127   </tp:docstring>
 128   </tp:enumvalue>
 129   <tp:enumvalue suffix="STATE_PRESSED" value="20">
 130   <tp:docstring>
 131     Indicates this object is currently pressed
 132   </tp:docstring>
 133   </tp:enumvalue>
 134   <tp:enumvalue suffix="STATE_RESIZABLE" value="21">
 135   <tp:docstring>
 136     Indicates the size of this object's size is not fixed
 137   </tp:docstring>
 138   </tp:enumvalue>
 139   <tp:enumvalue suffix="STATE_SELECTABLE" value="22">
 140   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 141     <p>Indicates this object is the child of an object that allows its
 142       children to be selected and that this child is one of those children
 143       that can be selected.</p>
 144   </tp:docstring>
 145   </tp:enumvalue>
 146   <tp:enumvalue suffix="STATE_SELECTED" value="23">
 147   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 148     <p>Indicates this object is the child of an object that allows its
 149       children to be selected and that this child is one of those children
 150       that has been selected.</p>
 151   </tp:docstring>
 152   </tp:enumvalue>
 153   <tp:enumvalue suffix="STATE_SENSITIVE" value="24">
 154   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 155     <p>Indicates this object is sensitive, e.g. to user interaction.
 156       STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls,
 157       but may be found in the absence of STATE_ENABLED if the current visible state of the
 158       control is &quot;disconnected&quot; from the application state.  In such cases, direct user interaction
 159       can often result in the object gaining STATE_SENSITIVE, for instance if a user makes
 160       an explicit selection using an object whose current state is ambiguous or undefined.
 161       @see STATE_ENABLED, STATE_INDETERMINATE. </p>
 162   </tp:docstring>
 163   </tp:enumvalue>
 164   <tp:enumvalue suffix="STATE_SHOWING" value="25">
 165   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 166     <p>Indicates this object, the object's parent, the object's parent's
 167       parent, and so on, are all 'shown' to the end-user, i.e.
 168       subject to &quot;exposure&quot; if blocking or obscuring objects do not interpose
 169       between this object and the top of the window stack.</p>
 170   </tp:docstring>
 171   </tp:enumvalue>
 172   <tp:enumvalue suffix="STATE_SINGLE_LINE" value="26">
 173   <tp:docstring>
 174     Indicates this (text) object can contain only a single line of text
 175   </tp:docstring>
 176   </tp:enumvalue>
 177   <tp:enumvalue suffix="STATE_STALE" value="27">
 178   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 179     <p>Indicates that the information returned for this object may no longer be
 180       synchronized with the application state.  This can occur if the object has STATE_TRANSIENT,
 181       and can also occur towards the end of the object peer's lifecycle. </p>
 182   </tp:docstring>
 183   </tp:enumvalue>
 184   <tp:enumvalue suffix="STATE_TRANSIENT" value="28">
 185   <tp:docstring>
 186     Indicates this object is transient
 187   </tp:docstring>
 188   </tp:enumvalue>
 189   <tp:enumvalue suffix="STATE_VERTICAL" value="29">
 190   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 191     <p>Indicates the orientation of this object is vertical; for example this state may appear on
 192       such objects as scrollbars, text objects (with vertical text flow), separators, etc.</p>
 193   </tp:docstring>
 194   </tp:enumvalue>
 195   <tp:enumvalue suffix="STATE_VISIBLE" value="30">
 196   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 197     <p>Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.
 198       @note: STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only
 199       that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the
 200       field of view, or having an ancestor container that has not yet made visible.
 201       A widget is potentially onscreen if it has both STATE_VISIBLE and STATE_SHOWING.
 202       The absence of STATE_VISIBLE and STATE_SHOWING is semantically equivalent to saying
 203       that an object is 'hidden'.</p>
 204   </tp:docstring>
 205   </tp:enumvalue>
 206   <tp:enumvalue suffix="STATE_MANAGES_DESCENDANTS" value="31">
 207   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 208     <p>Indicates that &quot;active-descendant-changed&quot; event is sent when children
 209       become 'active' (i.e. are selected or navigated to onscreen).  Used to
 210       prevent need to enumerate all children in very large containers, like
 211       tables.  The presence of STATE_MANAGES_DESCENDANTS is an indication to the client.
 212       that the children should not, and need not, be enumerated by the client.
 213       Objects implementing this state are expected to provide relevant state
 214       notifications to listening clients, for instance notifications of visibility
 215       changes and activation of their contained child objects, without the client
 216       having previously requested references to those children.</p>
 217   </tp:docstring>
 218   </tp:enumvalue>
 219   <tp:enumvalue suffix="STATE_INDETERMINATE" value="32">
 220   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 221     <p>Indicates that a check box or other boolean indicator is in a state other than
 222       checked or not checked.  This usually means that the boolean value reflected or
 223       controlled by the object does not apply consistently to the entire current context.
 224       For example, a checkbox for the &quot;Bold&quot; attribute of text may have STATE_INDETERMINATE
 225       if the currently selected text contains a mixture of weight attributes.
 226       In many cases interacting with a STATE_INDETERMINATE object will cause
 227       the context's corresponding boolean attribute to be homogenized, whereupon the object
 228       will lose STATE_INDETERMINATE and a corresponding state-changed event will be fired.</p>
 229   </tp:docstring>
 230   </tp:enumvalue>
 231   <tp:enumvalue suffix="STATE_REQUIRED" value="33">
 232   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 233     <p>Indicates that user interaction with this object is 'required' from the user,
 234       for instance before completing the processing of a form.</p>
 235   </tp:docstring>
 236   </tp:enumvalue>
 237   <tp:enumvalue suffix="STATE_TRUNCATED" value="34">
 238   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 239     <p>Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell.
 240       @since AT-SPI 1.7.0.</p>
 241   </tp:docstring>
 242   </tp:enumvalue>
 243   <tp:enumvalue suffix="STATE_ANIMATED" value="35">
 244   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 245     <p>Indicates this object's visual representation is dynamic, not static.
 246       This state may be applied to an object during an animated 'effect' and
 247       be removed from the object once its visual representation becomes static.
 248       @note some applications, notably content viewers, may not be able to detect
 249       all kinds of animated content.  Therefore the absence of this state should not
 250       be taken as definitive evidence that the object's visual representation is
 251       static; this state is advisory.  </p>
 252
 253     <p>@since AT-SPI 1.7.0</p>
 254   </tp:docstring>
 255   </tp:enumvalue>
 256   <tp:enumvalue suffix="STATE_INVALID_ENTRY" value="36">
 257   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 258     <p>This object has indicated an error condition due to failure of input
 259       validation.  For instance, a form control may acquire this state in response
 260       to invalid or malformed user input.  </p>
 261
 262     <p>@since AT-SPI 1.7.0 </p>
 263   </tp:docstring>
 264   </tp:enumvalue>
 265   <tp:enumvalue suffix="STATE_SUPPORTS_AUTOCOMPLETION" value="37">
 266   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 267     <p>This state indicates that the object in question implements some form of ¨typeahead¨ or
 268       pre-selection behavior whereby entering the first character of one or more sub-elements
 269       causes those elements to scroll into view or become selected.  Subsequent character input
 270       may narrow the selection further as long as one or more sub-elements match the string.
 271       This state is normally only useful and encountered on objects that implement Selection.
 272       In some cases the typeahead behavior may result in full or partial ¨completion¨ of
 273       the data in the input field, in which case these input events may trigger text-changed
 274       events from the source.  </p>
 275
 276     <p>@since AT-SPI 1.7.0 </p>
 277   </tp:docstring>
 278   </tp:enumvalue>
 279   <tp:enumvalue suffix="STATE_SELECTABLE_TEXT" value="38">
 280   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 281     <p>This state indicates that the object in question supports text selection.
 282       It should only be exposed on objects which implement the Text interface,
 283       in order to distinguish this state from STATE_SELECTABLE, which infers that
 284       the object in question is a selectable child of an object which implements
 285       Selection.  While similar, text selection and subelement selection are
 286       distinct operations.  </p>
 287
 288     <p>@since AT-SPI 1.7.0 </p>
 289   </tp:docstring>
 290   </tp:enumvalue>
 291   <tp:enumvalue suffix="STATE_IS_DEFAULT" value="39">
 292   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 293     <p>This state indicates that the object in question is the 'default' interaction object
 294       in a dialog, i.e. the one that gets activated if the user presses &quot;Enter&quot; when the
 295       dialog is initially posted.  </p>
 296
 297     <p>@since AT-SPI 1.7.0 </p>
 298   </tp:docstring>
 299   </tp:enumvalue>
 300   <tp:enumvalue suffix="STATE_VISITED" value="40">
 301   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 302     <p>This state indicates that the object (typically a hyperlink)
 303       has already been activated or invoked, with the result that some backing data
 304       has been downloaded or rendered.  </p>
 305
 306     <p>@since AT-SPI 1.7.1 </p>
 307   </tp:docstring>
 308   </tp:enumvalue>
 309   <tp:enumvalue suffix="STATE_LAST_DEFINED" value="41">
 310   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 311     <p>This value of the enumeration should not be used as a parameter, it indicates the number of
 312       items in the StateType enumeration.</p>
 313   </tp:docstring>
 314   </tp:enumvalue>
 315 </tp:enum>
 316 <interface name="org.freedesktop.atspi.StateSet">
 317   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 318     <p>The StateSet interface encapsulates a collection of state information.
 319       It allows comparison of state information between object instances, and comparisons
 320       of an object's state with some hypothetical collection of states.</p>
 321   </tp:docstring>
 322   <method name="contains">
 323     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 324       <p>Query a StateSet for a specific StateType.
 325         @param state the StateType being queried for.</p>
 326     </tp:docstring>
 327     <arg direction="in" name="state" type="u" tp:type="StateType"/>
 328     <arg direction="out" type="b" tp:type="boolean">
 329     <tp:docstring>
 330       \c TRUE if the StateSet contains StateType \a state.
 331     </tp:docstring>
 332     </arg>
 333   </method>
 334   <method name="add">
 335     <tp:docstring>
 336       Add a StateType to an existing StateSet, if not already present.
 337     </tp:docstring>
 338     <arg direction="in" name="state" type="u" tp:type="StateType"/>
 339   </method>
 340   <method name="remove">
 341     <tp:docstring>
 342       Remove a StateType to an existing StateSet, if it is present.
 343     </tp:docstring>
 344     <arg direction="in" name="state" type="u" tp:type="StateType"/>
 345   </method>
 346   <method name="equals">
 347     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 348       <p>Compare two statesets for equivalence.
 349         @param tarStateSet the StateSet to be compared with this one.</p>
 350     </tp:docstring>
 351     <arg direction="in" name="tarStateSet" type="o" tp:type="StateSet"/>
 352     <arg direction="out" type="b" tp:type="boolean">
 353     <tp:docstring>
 354       \c TRUE if the two StateSet objects are composed of the same StateTypes.
 355     </tp:docstring>
 356     </arg>
 357   </method>
 358   <method name="compare">
 359     <tp:docstring>
 360       Compare two StateSet instances and obtain their differences.
 361     </tp:docstring>
 362     <arg direction="in" name="compareState" type="o" tp:type="StateSet"/>
 363     <arg direction="out" type="o" tp:type="StateSet">
 364     <tp:docstring>
 365       a 'difference set', i.e. a StateSet consisting of those states not shared by the two sets being compared.
 366     </tp:docstring>
 367     </arg>
 368   </method>
 369   <method name="isEmpty">
 370     <arg direction="out" type="b" tp:type="boolean">
 371     <tp:docstring>
 372       \c TRUE if the StateSet contains no states.
 373     </tp:docstring>
 374     </arg>
 375   </method>
 376   <method name="getStates">
 377     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 378       <p>\cond
 379         Private </p>
 380     </tp:docstring>
 381     <arg direction="out" type="au" tp:type="StateSeq"/>
 382   </method>
 383   <method name="unImplemented">
 384     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 385       <p>unImplemented:    </p>
 386
 387       <p>placeholders for future expansion.</p>
 388     </tp:docstring>
 389   </method>
 390   <method name="unImplemented2">
 391   </method>
 392   <method name="unImplemented3">
 393   </method>
 394   <method name="unImplemented4">
 395   </method>
 396 </interface>
 397 </node>