<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
-
-
-
-
-
<interface name="org.freedesktop.atspi.Selection">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface which indicates that an object exposes a 'selection' model,
allowing the selection of one or more of its children. Read-only Selection
instances are possible, in which case the interface is used to programmatically
- determine the selected-ness of its children. A selected child has ::State::STATE_SELECTED,
+ determine the selected-ness of its children. A selected child has State.STATE_SELECTED,
and a child which may hypothetically be selected (though possibly not programmatically
- selectable) has ::State::STATE_SELECTABLE.
- @note Events emitted by implementors of Selection include:
- \li \c "object:selection-changed" An instance of Selection has undergone a change in the
+ selectable) has State.STATE_SELECTABLE.</p>
+ <p>Events emitted by implementors of Selection include:
+ <code>object:selection-changed</code> An instance of Selection has undergone a change in the
'selected-ness' of its children, i.e. had a selection added,
removed, and/or modified. Usually accompanied by
- corresponding \c "object:state-changed:selected" events
+ corresponding <code>object:state-changed:selected</code> events
from the corresponding children, unless the children are
previously un-queried via AT-SPI and the Selection instance
- has ::State::STATE_MANAGES_DESCENDANTS.</p>
+ has State.STATE_MANAGES_DESCENDANTS.</p>
</tp:docstring>
<tp:property name="nSelectedChildren" type="i" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
</tp:property>
<method name="getSelectedChild">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Get the i-th selected Accessible child of a Selection.
- @note \c selectedChildIndex refers to the index in the list of
+ <p>Get the i-th selected Accessible child of a Selection.</p>
+ <p><code>selectedChildIndex</code> refers to the index in the list of
'selected' children as opposed to the more general 'child index'
of an object; as such it generally differs from that used in
- Accessible::getChildAtIndex() or returned by
- Accessible::getIndexInParent().
- \c selectedChildIndex must lie between 0
- and Selection::nSelectedChildren-1, inclusive.</p>
+ Accessible.getChildAtIndex() or returned by
+ Accessible.getIndexInParent().
+ <code>selectedChildIndex</code> must lie between 0
+ and Selection.nSelectedChildren-1, inclusive.</p>
</tp:docstring>
<arg direction="in" name="selectedChildIndex" type="i">
<tp:docstring>
- a long integer indicating which of the selected children of an object is being requested.
+ A long integer indicating which of the selected children of an object is being requested.
</tp:docstring>
</arg>
<arg direction="out" type="o" tp:type="Accessible">
<tp:docstring>
- a pointer to a selected Accessible child object,specified by \c selectedChildIndex.
+ A pointer to a selected Accessible child object,specified by <code>selectedChildIndex</code>.
</tp:docstring>
</arg>
</method>
<method name="selectChild">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Add a child to the selected children list of a Selection.
- @note For Selection implementors that only allow
+ <p>Add a child to the selected children list of a Selection.</p>
+ <p>For Selection implementors that only allow
single selections, this call may result in the
replacement of the (single) current
- selection. The call may return \c False if
- the child is not selectable (i.e. does not have ::State::STATE_SELECTABLE),
+ selection. The call may return <code>False</code> if
+ the child is not selectable (i.e. does not have State.STATE_SELECTABLE),
if the user does not have permission to change the selection,
- or if the Selection instance does not have ::State::STATE_SENSITIVE. </p>
+ or if the Selection instance does not have State.STATE_SENSITIVE. </p>
</tp:docstring>
<arg direction="in" name="childIndex" type="i">
<tp:docstring>
- a long integer indicating which child of theSelection is to be selected.
+ A long integer indicating which child of theSelection is to be selected.
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the child was successfully selected, \c False otherwise.
+ <code>True</code> if the child was successfully selected, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<method name="deselectSelectedChild">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Remove a child to the selected children list of a Selection.
- @note \c childIndex is the index in the selected-children list,
- not the index in the parent container. \c selectedChildIndex in this
- method, and \c childIndex in Selection::selectChild
- are asymmettric. </p>
+ <p>Remove a child to the selected children list of a Selection.</p>
+ <p><code>childIndex</code> is the index in the selected-children list,
+ not the index in the parent container. <code>selectedChildIndex</code> in this
+ method, and <code>childIndex</code> in Selection.selectChild
+ are asymmettric.</p>
</tp:docstring>
<arg direction="in" name="selectedChildIndex" type="i">
<tp:docstring>
- 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.
+ 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.
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the child was successfully deselected, \c False otherwise.@see deselectChild
+ <code>True</code> if the child was successfully deselected, <code>False</code> otherwise, see deselectChild
</tp:docstring>
</arg>
</method>
<method name="isChildSelected">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Determine whether a particular child of an Selection implementor
- is currently selected. Note that \c childIndex is the zero-offset
+ is currently selected. Note that <code>childIndex</code> is the zero-offset
index into the standard Accessible container's list of children. </p>
</tp:docstring>
<arg direction="in" name="childIndex" type="i">
<tp:docstring>
- an index into the Selection's list of children.
+ An index into the Selection's list of children.
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the specified child is currently selected,\c False otherwise.
+ <code>True</code> if the specified child is currently selected,<code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Attempt to select all of the children of a Selection implementor.
Not all Selection implementors support this operation (for instance,
- implementations which support only "single selection" do not support this operation). </p>
+ implementations which support only "single selection" do not support this operation).</p>
</tp:docstring>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if successful, \c False otherwise.
+ <code>True</code> if successful, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<p>Attempt to clear all selections (i.e. deselect all children) of a Selection.
Not all Selection implementations allow the removal of all selections. </p>
- <p>@note this operation may fail if the object must have at least one selected child,
+ <p>This operation may fail if the object must have at least one selected child,
if the user does not have permission to change the selection, or if the Selection
- does not have ::State::STATE_SENSITIVE. </p>
+ does not have State.STATE_SENSITIVE. </p>
</tp:docstring>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the selections were successfully cleared, \c False otherwise.
+ <code>True</code> if the selections were successfully cleared, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<p>Remove a child from the selected children list of a Selection,
if the child is currently selected. </p>
- <p>@note unlike deselectSelectedChild, \c childIndex is the zero-offset
+ <p>Unlike deselectSelectedChild, <code>childIndex</code> is the zero-offset
index into the Accessible instance's list of children,
not the index into the 'selected child list'. </p>
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the child was successfully selected, \c False otherwise.@see deselectSelectedChild@since AT-SPI 1.8.0
+ <code>True</code> if the child was successfully selected, <code>False</code> otherwise, see deselectSelectedChild.
</tp:docstring>
</arg>
</method>
- <method name="unImplemented">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>unImplemented: </p>
-
- <p>placeholders for future expansion.</p>
- </tp:docstring>
- </method>
- <method name="unImplemented2">
- </method>
- <method name="unImplemented3">
- </method>
</interface>
</node>
projects / platform / core / uifw / at-spi2-atk.git / blobdiff