xml/org.freedesktop.atspi.State.xml

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