xml/org.freedesktop.atspi.Selection.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 <interface name="org.freedesktop.atspi.Selection">
   9   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  10     <p>An interface which indicates that an object exposes a 'selection' model,
  11       allowing the selection of one or more of its children.  Read-only Selection
  12       instances are possible, in which case the interface is used to programmatically
  13       determine the selected-ness of its children.  A selected child has ::State::STATE_SELECTED,
  14       and a child which may hypothetically be selected (though possibly not programmatically
  15       selectable) has ::State::STATE_SELECTABLE.
  16       @note Events emitted by implementors of Selection include:
  17       \li \c "object:selection-changed" An instance of Selection has undergone a change in the
  18       'selected-ness' of its children, i.e. had a selection added,
  19       removed, and/or modified.  Usually accompanied by
  20       corresponding \c "object:state-changed:selected" events
  21       from the corresponding children, unless the children are
  22       previously un-queried via AT-SPI and the Selection instance
  23       has ::State::STATE_MANAGES_DESCENDANTS.</p>
  24   </tp:docstring>
  25   <tp:property name="nSelectedChildren" type="i" access="read">
  26   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  27     <p>The number of children of a Selection implementor which are
  28       currently selected.</p>
  29   </tp:docstring>
  30   </tp:property>
  31   <method name="getSelectedChild">
  32     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  33       <p>Get the i-th selected Accessible child of a Selection.
  34         @note \c selectedChildIndex refers to the index in the list of
  35         'selected' children as opposed to the more general 'child index'
  36         of an object;  as such it generally differs from that used in
  37         Accessible::getChildAtIndex() or returned by
  38         Accessible::getIndexInParent().
  39         \c selectedChildIndex must lie between 0
  40         and Selection::nSelectedChildren-1, inclusive.</p>
  41     </tp:docstring>
  42     <arg direction="in" name="selectedChildIndex" type="i">
  43     <tp:docstring>
  44       a long integer indicating which of the selected children of an object is being requested.
  45     </tp:docstring>
  46     </arg>
  47     <arg direction="out" type="o" tp:type="Accessible">
  48     <tp:docstring>
  49       a pointer to a selected Accessible child object,specified by \c selectedChildIndex.
  50     </tp:docstring>
  51     </arg>
  52   </method>
  53   <method name="selectChild">
  54     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  55       <p>Add a child to the selected children list of a Selection.
  56         @note For Selection implementors that only allow
  57         single selections, this call may result in the
  58         replacement of the (single) current
  59         selection.  The call may return \c False if
  60         the child is not selectable (i.e. does not have ::State::STATE_SELECTABLE),
  61         if the user does not have permission to change the selection,
  62         or if the Selection instance does not have ::State::STATE_SENSITIVE.    </p>
  63     </tp:docstring>
  64     <arg direction="in" name="childIndex" type="i">
  65     <tp:docstring>
  66       a long integer indicating which child of theSelection is to be selected.
  67     </tp:docstring>
  68     </arg>
  69     <arg direction="out" type="b" tp:type="boolean">
  70     <tp:docstring>
  71       \c True if the child was successfully selected, \c False otherwise.
  72     </tp:docstring>
  73     </arg>
  74   </method>
  75   <method name="deselectSelectedChild">
  76     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  77       <p>Remove a child to the selected children list of a Selection.
  78         @note \c childIndex is the index in the selected-children list,
  79         not the index in the parent container.  \c selectedChildIndex in this
  80         method, and \c childIndex in Selection::selectChild
  81         are asymmettric.    </p>
  82     </tp:docstring>
  83     <arg direction="in" name="selectedChildIndex" type="i">
  84     <tp:docstring>
  85       a long integer indicating which of the selected children of the Selection is to be deselected.  The indexis a zero-offset index into the 'selected child list', nota zero-offset index into the list of all children of the Selection.
  86     </tp:docstring>
  87     </arg>
  88     <arg direction="out" type="b" tp:type="boolean">
  89     <tp:docstring>
  90       \c True if the child was successfully deselected, \c False otherwise.@see deselectChild
  91     </tp:docstring>
  92     </arg>
  93   </method>
  94   <method name="isChildSelected">
  95     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  96       <p>Determine whether a particular child of an Selection implementor
  97         is currently selected.  Note that \c childIndex is the zero-offset
  98         index into the standard Accessible container's list of children.    </p>
  99     </tp:docstring>
 100     <arg direction="in" name="childIndex" type="i">
 101     <tp:docstring>
 102       an index into the Selection's list of children.
 103     </tp:docstring>
 104     </arg>
 105     <arg direction="out" type="b" tp:type="boolean">
 106     <tp:docstring>
 107       \c True if the specified child is currently selected,\c False otherwise.
 108     </tp:docstring>
 109     </arg>
 110   </method>
 111   <method name="selectAll">
 112     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 113       <p>Attempt to select all of the children of a Selection implementor.
 114         Not all Selection implementors support this operation (for instance,
 115         implementations which support only "single selection" do not support this operation).    </p>
 116     </tp:docstring>
 117     <arg direction="out" type="b" tp:type="boolean">
 118     <tp:docstring>
 119       \c True if successful, \c False otherwise.
 120     </tp:docstring>
 121     </arg>
 122   </method>
 123   <method name="clearSelection">
 124     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 125       <p>Attempt to clear all selections (i.e. deselect all children) of a Selection.
 126         Not all Selection implementations allow the removal of all selections.    </p>
 127
 128       <p>@note this operation may fail if the object must have at least one selected child,
 129         if the user does not have permission to change the selection, or if the Selection
 130         does not have ::State::STATE_SENSITIVE.    </p>
 131     </tp:docstring>
 132     <arg direction="out" type="b" tp:type="boolean">
 133     <tp:docstring>
 134       \c True if the selections were successfully cleared, \c False otherwise.
 135     </tp:docstring>
 136     </arg>
 137   </method>
 138   <method name="deselectChild">
 139     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 140       <p>Remove a child from the selected children list of a Selection,
 141         if the child is currently selected.    </p>
 142
 143       <p>@note unlike deselectSelectedChild, \c childIndex is the zero-offset
 144         index into the Accessible instance's list of children,
 145         not the index into the 'selected child list'.    </p>
 146     </tp:docstring>
 147     <arg direction="in" name="childIndex" type="i">
 148     <tp:docstring>
 149       a long integer (the zero offset index into the Accessibleobject's list of children) indicating which child of theSelection is to be selected.
 150     </tp:docstring>
 151     </arg>
 152     <arg direction="out" type="b" tp:type="boolean">
 153     <tp:docstring>
 154       \c True if the child was successfully selected, \c False otherwise.@see deselectSelectedChild@since AT-SPI 1.8.0
 155     </tp:docstring>
 156     </arg>
 157   </method>
 158   <method name="unImplemented">
 159     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 160       <p>unImplemented:    </p>
 161
 162       <p>placeholders for future expansion.</p>
 163     </tp:docstring>
 164   </method>
 165   <method name="unImplemented2">
 166   </method>
 167   <method name="unImplemented3">
 168   </method>
 169 </interface>
 170 </node>