<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
-
-
-
-
-
<tp:enum name="ComponentLayer" type="u">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The ComponentLayer of a Component instance indicates its relative stacking order
overpainted by later siblings if their bounds intersect. </p>
<p>The order of layers, from bottom to top, is:
- \li LAYER_BACKGROUND
- \li LAYER_WINDOW
- \li LAYER_MDI
- \li LAYER_CANVAS
- \li LAYER_WIDGET
- \li LAYER_POPUP
- \li LAYER_OVERLAY</p>
+ <ol>
+ <li>LAYER_BACKGROUND</li>
+ <li>LAYER_WINDOW</li>
+ <li>LAYER_MDI</li>
+ <li>LAYER_CANVAS</li>
+ <li>LAYER_WIDGET</li>
+ <li>LAYER_POPUP</li>
+ <li>LAYER_OVERLAY</li>
+ </ol>
+ </p>
</tp:docstring>
<tp:enumvalue suffix="LAYER_INVALID">
<tp:docstring>
- < Indicates an error condition or uninitialized value.
+ Indicates an error condition or uninitialized value.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="LAYER_BACKGROUND" value="1">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< The bottom-most layer, over which everything else is painted.
+ <p>The bottom-most layer, over which everything else is painted.
The 'desktop background' is generally in this layer. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="LAYER_CANVAS" value="2">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< The 'background' layer for most content renderers and UI Component
+ <p>The 'background' layer for most content renderers and UI Component
containers. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="LAYER_WIDGET" value="3">
<tp:docstring>
- < The layer in which the majority of ordinary 'foreground' widgets reside.
+ The layer in which the majority of ordinary 'foreground' widgets reside.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="LAYER_MDI" value="4">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< A special layer between LAYER_CANVAS and LAYER_WIDGET, in which the
+ <p>A special layer between LAYER_CANVAS and LAYER_WIDGET, in which the
'pseudo windows' (e.g. the MDI frames) reside.
- @see Component::getMDIZOrder </p>
+ (See Component.getMDIZOrder) </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="LAYER_POPUP" value="5">
<tp:docstring>
- < A layer for popup window content, above LAYER_WIDGET.
+ A layer for popup window content, above LAYER_WIDGET.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="LAYER_OVERLAY" value="6">
<tp:docstring>
- < The topmost layer.
+ The topmost layer.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="LAYER_WINDOW" value="7">
<tp:docstring>
- < The layer in which a toplevel window background usually resides.
+ The layer in which a toplevel window background usually resides.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="LAYER_LAST_DEFINED" value="8">
<tp:docstring>
- < Used only to determine the end of the enumeration.
+ Used only to determine the end of the enumeration.
</tp:docstring>
</tp:enumvalue>
</tp:enum>
user interface elements programmatically. This is a 2D API, coordinates of 3D objects are projected into the
2-dimensional screen view for purposes of this interface. </p>
- <p>@note the meaning and defined values of the \c short \c coord_type parameter used by some
- Component methods is as follows:
- \li 0 indicates coord_type_xy_screen, coordinates are relative to the display screen, in pixels.
- \li 1 indicates coord_type_xy_window, coordinates are relative to the current toplevel window, in pixels. </p>
-
- <p>@note Events emitted by Component instances include:
- \li \c "object:bounds-changed"
- \li \c "object:visible-data-changed"</p>
+ <p>Events emitted by Component instances include:
+ <ol>
+ <li><code>"object:bounds-changed"</code></li>
+ <li><code>"object:visible-data-changed"</code></li>
+ </ol>
+ </p>
</tp:docstring>
<method name="contains">
<arg direction="in" name="x" type="i"/>
<arg direction="in" name="coord_type" type="n" tp:type="short"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the specified point lies within the Component's bounding box, \c False otherwise.
+ <code>True</code>if the specified point lies within the Component's bounding box, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<arg direction="in" name="coord_type" type="n" tp:type="short"/>
<arg direction="out" type="o" tp:type="Accessible">
<tp:docstring>
- the Accessible child whose bounding box contains the specified point.
+ The Accessible child whose bounding box contains the specified point.
</tp:docstring>
</arg>
</method>
<arg direction="in" name="coord_type" type="n" tp:type="short"/>
<arg direction="out" type="(iiii)" tp:type="BoundingBox">
<tp:docstring>
- a BoundingBox which entirely contains the object's onscreen visual representation.
+ A BoundingBox which entirely contains the object's onscreen visual representation.
</tp:docstring>
</arg>
</method>
<method name="getPosition">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain the position of the current component in the coordinate system specified
- by \c coord_type.
- @param coord_type
- @param x an out parameter which will be back-filled with the returned x coordinate.
- @param y an out parameter which will be back-filled with the returned y coordinate.</p>
+ by <code>coord_type.</code>
+ </p>
</tp:docstring>
- <arg direction="out" name="x" type="i"/>
- <arg direction="out" name="y" type="i"/>
- <arg direction="in" name="coord_type" type="n" tp:type="short"/>
+ <arg direction="in" name="coord_type" type="n" tp:type="short">
+ <tp:docstring>
+ <ol>
+ <li>0 indicates coord_type_xy_screen, coordinates are relative to the display screen, in pixels.</li>
+ <li>1 indicates coord_type_xy_window, coordinates are relative to the current toplevel window, in pixels.</li>
+ </ol>
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="x" type="i">
+ <tp:docstring>
+ An out parameter which will be back-filled with the returned x coordinate.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="y" type="i">
+ <tp:docstring>
+ <p>An out parameter which will be back-filled with the returned y coordinate.</p>
+ </tp:docstring>
+ </arg>
</method>
<method name="getSize">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain the size, in the coordinate system specified by \c coord_type,
of the rectangular area which fully contains the object's
visual representation, without accounting for viewport clipping.
- @param width the object's horizontal extents in the specified coordinate system.
- @param height the object's vertical extents in the specified coordinate system.</p>
+ </p>
</tp:docstring>
- <arg direction="out" name="width" type="i"/>
- <arg direction="out" name="height" type="i"/>
+ <arg direction="out" name="width" type="i">
+ <tp:docstring>
+ The object's horizontal extents in the specified coordinate system.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="height" type="i">
+ <tp:docstring>
+ <p>The object's vertical extents in the specified coordinate system.</p>
+ </tp:docstring>
+ </arg>
</method>
<method name="getLayer">
<arg direction="out" type="u" tp:type="ComponentLayer">
<tp:docstring>
- the ComponentLayer in which this object resides.
+ The ComponentLayer in which this object resides.
</tp:docstring>
</arg>
</method>
<p>Obtain the relative stacking order (i.e. 'Z' order) of an object.
Larger values indicate that an object is on "top" of the stack, therefore
objects with smaller MDIZOrder may be obscured by objects with a larger MDIZOrder,
- but not vice-versa.
- @note only relevant for objects in LAYER_MDI or LAYER_WINDOW </p>
+ but not vice-versa. This is only relevant for objects in LAYER_MDI or LAYER_WINDOW </p>
</tp:docstring>
<arg direction="out" type="n" tp:type="short">
<tp:docstring>
- an integer indicating the object's place in the stacking order.
+ An integer indicating the object's place in the stacking order.
</tp:docstring>
</arg>
</method>
<method name="grabFocus">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Request that the object obtain keyboard focus. </p>
+ <p>Request that the object obtain keyboard focus.</p>
</tp:docstring>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if keyboard focus was successfully transferred to the Component.
+ <code>True</code> if keyboard focus was successfully transferred to the Component.
</tp:docstring>
</arg>
</method>
<method name="registerFocusHandler">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Register an EventListener for notification when this object receives keyboard focus.
- @note you probably want to register for ¨focus:¨ events via
- Registry::registerGlobalEventListener instead. </p>
+ You probably want to register for focus events via
+ Registry.registerGlobalEventListener instead. </p>
</tp:docstring>
<arg direction="in" name="handler" type="o" tp:type="EventListener"/>
</method>
that the object is fully transparent. Negative alpha values have no defined
meaning at this time. </p>
- <p>@note alpha values are used in conjunction with Z-order calculations to
+ <p>Alpha values are used in conjunction with Z-order calculations to
determine whether an object wholly or partially obscures another object's
visual intersection, in the event that their bounds intersect. </p>
- <p>@see STATE_OPAQUE </p>
-
- <p>@since AT-SPI 1.7.0</p>
</tp:docstring>
<arg direction="out" type="d"/>
</method>
- <method name="unImplemented">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>\cond
- unImplemented: </p>
-
- <p>placeholders for future expansion.</p>
- </tp:docstring>
- </method>
- <method name="unImplemented2">
- </method>
- <method name="unImplemented3">
- </method>
</interface>
</node>
<?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.Desktop">
<tp:property name="childCount" type="i" access="read">
<tp:docstring>
- childCount: the number of children contained by this object.
+ The number of children contained by this object.
</tp:docstring>
</tp:property>
<method name="getChildren">
<tp:docstring>
- Get the accessible children of this object.
+ Get the Accessible children of this object.
</tp:docstring>
<arg direction="out" type="as" tp:type="AccessibleSet">
<tp:docstring>
- the ::Accessible children of this object.
+ The Accessible children of this object.
</tp:docstring>
</arg>
</method>
<method name="getChildAtIndex">
<tp:docstring>
- Get the accessible child of this object at \c index.
+ Get the accessible child of this object at <code>index</code>.
</tp:docstring>
<arg direction="in" name="index" type="i">
<tp:docstring>
- an in parameter indicating which child is requested (zero-indexed).
+ An parameter indicating which child is requested (zero-indexed).
</tp:docstring>
</arg>
<arg direction="out" type="s" tp:type="Accessible">
<tp:docstring>
- the 'nth' ::Accessible child of this object.
+ The 'nth' Accessible child of this object.
</tp:docstring>
</arg>
</method>
<?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.DeviceEventController">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The interface via which clients request notification of device events, and
</tp:docstring>
<arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
<tp:docstring>
- a DeviceEventListener which will intercept key events.
+ A DeviceEventListener which will intercept key events.
</tp:docstring>
</arg>
<arg direction="in" name="keys" type="a(iisi)" tp:type="KeySet">
<tp:docstring>
- a KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
+ A KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
</tp:docstring>
</arg>
<arg direction="in" name="mask" type="u" tp:type="ControllerEventMask">
<tp:docstring>
- a ControllerEventMask filtering the intercepted key events.
+ A ControllerEventMask filtering the intercepted key events.
</tp:docstring>
</arg>
<arg direction="in" name="type" type="u" tp:type="KeyEventTypeSeq">
<tp:docstring>
- a KeyEventTypeSeq that may created by ORing event types together.
+ A KeyEventTypeSeq that may created by ORing event types together.
</tp:docstring>
</arg>
<arg direction="in" name="mode" type="(bbb)" tp:type="EventListenerMode">
<tp:docstring>
- an EventListenerMode indicating whether the listener should receive the events synchronously, potentially consuming them,or just be notified asynchronously of those events that havebeen generated.@note Some platforms have limited support for global, preemptive EventListenerMode.Such a registration may fail if another client already has priority for preemptiveaccess to one or more of the members of the KeySet. AT consumers have the optionof re-trying the request without the global flag, or without the preemptive flag,or of re-trying with a different KeySet. The best support for pre-emptiveglobal keyboard listeners is provided on platforms whose Xserver implementationprovides the XEvIE extension.
+ An EventListenerMode indicating whether the listener should receive the events synchronously, potentially consuming them,or just be notified asynchronously of those events that havebeen generated.@note Some platforms have limited support for global, preemptive EventListenerMode.Such a registration may fail if another client already has priority for preemptiveaccess to one or more of the members of the KeySet. AT consumers have the optionof re-trying the request without the global flag, or without the preemptive flag,or of re-trying with a different KeySet. The best support for pre-emptiveglobal keyboard listeners is provided on platforms whose Xserver implementationprovides the XEvIE extension.
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the DeviceEventListener was successfully registeredfor the requested KeySet, ControllerEventMask, event types, and EventListenerMode; otherwise returns \c False.
+ <code>True</code> if the DeviceEventListener was successfully registeredfor the requested KeySet, ControllerEventMask, event types, and EventListenerMode; otherwise returns <code>False</code>.
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
<tp:docstring>
- a DeviceEventListener which will intercept key events.
+ A DeviceEventListener which will intercept key events.
</tp:docstring>
</arg>
<arg direction="in" name="keys" type="a(iisi)" tp:type="KeySet">
<tp:docstring>
- a KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
+ A KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
</tp:docstring>
</arg>
<arg direction="in" name="mask" type="u" tp:type="ControllerEventMask">
<tp:docstring>
- a ControllerEventMask filtering the intercepted key events.
+ A ControllerEventMask filtering the intercepted key events.
</tp:docstring>
</arg>
<arg direction="in" name="type" type="u" tp:type="KeyEventTypeSeq">
<tp:docstring>
- an EventType mask that may created by ORing event types together.
+ An EventType mask that may created by ORing event types together.
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
<tp:docstring>
- a DeviceEventListener which will intercept events.
+ A DeviceEventListener which will intercept events.
</tp:docstring>
</arg>
<arg direction="in" name="types" type="u" tp:type="EventTypeSeq">
<tp:docstring>
- an EventTypeSeq indicating which event types to listen for.
+ An EventTypeSeq indicating which event types to listen for.
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if successful, \c False if not
+ <code>True</code> if successful, <code>False</code> if not.
</tp:docstring>
</arg>
</method>
</arg>
<arg direction="in" name="types" type="u" tp:type="EventTypeSeq">
<tp:docstring>
- an EventTypeSeq indicating which event types to stoplistening for.
+ An EventTypeSeq indicating which event types to stoplistening for.
</tp:docstring>
</arg>
</method>
method used by accessibility bridges to forward "toolkit dependent"
device events to the Registry from the application's process space. </p>
- <p>@note AT clients do not normally need to use this method, it is intended for use
+ <p>AT clients do not normally need to use this method, it is intended for use
by toolkit bridges and special-purpose applications. </p>
</tp:docstring>
<arg direction="in" name="event" type="(uinnisb)" tp:type="DeviceEvent"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the event was consumed by a (pre-emptive) listener,\c False if not (in which case the device event will be forwardedas normal to any application which would normally receive it, e.g.the currently active application in the case of mouse or keyboard events).
+ <code>True</code> if the event was consumed by a (pre-emptive) listener, <code>False</code> if not (in which case the device event will be forwardedas normal to any application which would normally receive it, e.g.the currently active application in the case of mouse or keyboard events).
</tp:docstring>
</arg>
</method>
method used by accessibility bridges to forward "toolkit dependent"
device events to the Registry from the application's process space.
If the event in question is potentially pre-emptible.
- ::notifyListenersSync should be used instead. </p>
+ notifyListenersSync should be used instead. </p>
- <p>@note AT clients do not normally need to use this method, it is intended for use
+ <p>AT clients do not normally need to use this method, it is intended for use
by toolkit bridges and special-purpose applications.</p>
</tp:docstring>
<arg direction="in" name="event" type="(uinnisb)" tp:type="DeviceEvent"/>
</tp:docstring>
<arg direction="in" name="keycode" type="i">
<tp:docstring>
- a long integer indicating the keycode ofthe keypress to be synthesized.
+ A long integer indicating the keycode ofthe keypress to be synthesized.
</tp:docstring>
</arg>
<arg direction="in" name="keystring" type="s">
<tp:docstring>
- an optional UTF-8 string indicating a complexkeyboard input event.
+ An optional UTF-8 string indicating a complexkeyboard input event.
</tp:docstring>
</arg>
<arg direction="in" name="type" type="u" tp:type="KeySynthType">
<tp:docstring>
- a KeySynthType indicating the type of event(s) to be synthesized: a key press, release, press-release pair,or a complex input string (for instance from aninternationalized or complex text input method, ora composed character).@note keycode may be truncated before beingprocessed, as keycode length may be platform-dependentand keycode ranges are generally much smaller thanCORBA_long. One or the other of keycode or keystring are generally NULL, (but not both), depending on the value of \c type.
+ <p>A KeySynthType indicating the type of event(s) to be synthesized: a key press, release, press-release pair,or a complex input string (for instance from aninternationalized or complex text input method, ora composed character).</p>
+
+ <p>Keycode may be truncated before beingprocessed, as keycode length may be platform-dependentand keycode ranges are generally much smaller thanCORBA_long. One or the other of keycode or keystring are generally NULL, (but not both), depending on the value of <code>type</code>.</p>
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="in" name="x" type="i">
<tp:docstring>
- a long integer indicating the screen x coord for the mouse event.
+ A long integer indicating the screen x coord for the mouse event.
</tp:docstring>
</arg>
<arg direction="in" name="y" type="i">
<tp:docstring>
- a long integer indicating the screen y coord for the mouse event.
+ A long integer indicating the screen y coord for the mouse event.
</tp:docstring>
</arg>
<arg direction="in" name="eventName" type="s">
<tp:docstring>
- a string indicating the type of mouse event, e.g. "button1up"
+ A string indicating the type of mouse event, e.g. "button1up"
</tp:docstring>
</arg>
</method>
<?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.DeviceEventListener">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>This interface should be implemented by AT-SPI clients who wish to
<arg direction="in" name="event" type="(uinnisb)" tp:type="DeviceEvent"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the recipient/consumer wishes to consume the event, i.e.prevent it from being delivered to the desktop, \c False if the event should continue to be delivered as normal.
+ <code>True</code> if the recipient/consumer wishes to consume the event, i.e.prevent it from being delivered to the desktop, <code>False</code> if the event should continue to be delivered as normal.
</tp:docstring>
</arg>
</method>
<?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.Document">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Primarily a 'tagging' interface which indicates the start of
Attributes of Document are those attributes associated with the document
as a whole. Objects that implement Document are normally expected to
implement Collection as well. </p>
-
- <p>\see Accessibility::Collection</p>
</tp:docstring>
<method name="getLocale">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
</tp:docstring>
<arg direction="out" type="s">
<tp:docstring>
- a string compliant with the POSIX standard for locale description.
+ A string compliant with the POSIX standard for locale description.
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="in" name="attributename" type="s">
<tp:docstring>
- a string indicating the name of a specific attribute (name-value pair) being queried.
+ A string indicating the name of a specific attribute (name-value pair) being queried.
</tp:docstring>
</arg>
<arg direction="out" type="s">
<tp:docstring>
- a string corresponding to the value of the specified attribute, oran empty string if the attribute is unspecified for the object.
+ A string corresponding to the value of the specified attribute, oran empty string if the attribute is unspecified for the object.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Gets all attributes specified for a document as a whole.
For attributes which change within
- the document content, see Accessibility::Text::getAttributes instead. </p>
+ the document content, see Text.getAttributes instead. </p>
</tp:docstring>
<arg direction="out" type="as" tp:type="AttributeSet">
<tp:docstring>
- an ::AttributeSet containing the attributes of the document, as name-value pairs.@since AT-SPI 1.8.0
+ A list of strings containing the attributes of the document, as name-value pairs.
</tp:docstring>
</arg>
</method>
- <method name="unImplemented_">
- <tp:docstring>
- \cond
- </tp:docstring>
- </method>
- <method name="unImplemented2_">
- </method>
- <method name="unImplemented3_">
- </method>
- <method name="unImplemented4_">
- </method>
</interface>
</node>
<?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.EditableText">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Derived from interface Text, EditableText provides methods for
EditableText also interacts with the system clipboard via copyText,
cutText, and pasteText. </p>
- <p>@note read-only instances of EditableText are possible;
+ <p>Read-only instances of EditableText are possible;
These may be instances of a general-purpose component type which are
sometimes, but not always, user-editable, or may be
components which are temporarily or circumstantially
<method name="setTextContents">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Replace the text contents with a new string, discarding the old contents. </p>
-
- <p>@param newContents a UTF-8 string with which the text object's contents will be replaced.</p>
</tp:docstring>
- <arg direction="in" name="newContents" type="s"/>
+ <arg direction="in" name="newContents" type="s">
+ <tp:docstring>
+ A UTF-8 string with which the text object's contents will be replaced.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the text content was successfully changed, \c False otherwise.
+ <code>True</code> if the text content was successfully changed, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Insert new text contents into an existing text object at a given location, while retaining
the old contents.
- @param position the character offset into the Text implementor's content at which the
+ </p>
+ </tp:docstring>
+ <arg direction="in" name="position" type="i">
+ <tp:docstring>
+ The character offset into the Text implementor's content at which the
new content will be inserted.
- @param text a UTF-8 string of which \c length characters will be inserted into the text
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="text" type="s">
+ <tp:docstring>
+ A UTF-8 string of which <code>length</code> characters will be inserted into the text
object's text buffer.
- @param length the number of characters of \c text to insert. If the character count
- of \c text is less than or equal to \c length, the entire contents of \c text
- will be inserted. </p>
- </tp:docstring>
- <arg direction="in" name="position" type="i"/>
- <arg direction="in" name="text" type="s"/>
- <arg direction="in" name="length" type="i"/>
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="length" type="i">
+ <tp:docstring>
+ The number of characters of <code>text</code> to insert. If the character count
+ of <code>text</code> is less than or equal to <code>length</code>, the entire contents
+ of <code>text</code> will be inserted.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the text content was successfully inserted, \c False otherwise.
+ <code>True</code> if the text content was successfully inserted, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<arg direction="in" name="endPos" type="i"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the text attributes were successfully modified, \c False otherwise.
+ <code>True</code> if the text attributes were successfully modified, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<method name="copyText">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Copy a range of text into the system clipboard.
- @param startPos the character offset of the first character in the range of text being
- copied.
- @param endPos the offset of the first character past the end of the range of text
- being copied.</p>
+ </p>
</tp:docstring>
- <arg direction="in" name="startPos" type="i"/>
- <arg direction="in" name="endPos" type="i"/>
+ <arg direction="in" name="startPos" type="i">
+ <tp:docstring>
+ The character offset of the first character in the range of text being
+ copied.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="endPos" type="i">
+ <tp:docstring>
+ The offset of the first character past the end of the range of text
+ being copied.
+ </tp:docstring>
+ </arg>
</method>
<method name="cutText">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Excise a range of text from a Text object, copying it into the system clipboard.
- @param startPos the character offset of the first character in the range of text being
+ <p>Excise a range of text from a Text object, copying it into the system clipboard. </p>
+ </tp:docstring>
+ <arg direction="in" name="startPos" type="i">
+ <tp:docstring>
+ The character offset of the first character in the range of text being
cut.
- @param endPos the offset of the first character past the end of the range of text
- being cut.</p>
</tp:docstring>
- <arg direction="in" name="startPos" type="i"/>
- <arg direction="in" name="endPos" type="i"/>
+ </arg>
+ <arg direction="in" name="endPos" type="i">
+ <tp:docstring>
+ The offset of the first character past the end of the range of text
+ being cut.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the text was successfully cut, \c False otherwise.
+ <code>True</code> if the text was successfully cut, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<method name="deleteText">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Excise a range of text from a Text object without copying it into the system clipboard.
- @param startPos the character offset of the first character in the range of text being
+ <p>Excise a range of text from a Text object without copying it into the system clipboard. </p>
+ </tp:docstring>
+ <arg direction="in" name="startPos" type="i">
+ <tp:docstring>
+ The character offset of the first character in the range of text being
deleted.
- @param endPos the offset of the first character past the end of the range of text
- being deleted.</p>
</tp:docstring>
- <arg direction="in" name="startPos" type="i"/>
- <arg direction="in" name="endPos" type="i"/>
+ </arg>
+ <arg direction="in" name="endPos" type="i">
+ <tp:docstring>
+ The offset of the first character past the end of the range of text
+ being deleted.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the text was successfully deleted, \c False otherwise.
+ <code>True</code> if the text was successfully deleted, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Copy the text contents of the system clipboard, if any, into a Text object,
inserting it at a particular character offset. </p>
-
- <p>@param position the character offset before which the text will be inserted.</p>
</tp:docstring>
- <arg direction="in" name="position" type="i"/>
+ <arg direction="in" name="position" type="i">
+ <tp:docstring>
+ <p>The character offset before which the text will be inserted.</p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the text was successfully pasted into the Text object, \c False otherwise.
+ <code>True</code> if the text was successfully pasted into the Text object, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
- <method name="unImplemented5">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>unImplemented: </p>
-
- <p>placeholders for future expansion. Note that these are named
- 'unimplemented5 and unimplemented6' to avoid conflict with
- placeholders from Accessibility::Text.</p>
- </tp:docstring>
- </method>
- <method name="unImplemented6">
- </method>
- <method name="unImplemented9">
- </method>
- <method name="unImplemented10">
- </method>
- <method name="unImplemented11">
- </method>
- <method name="unImplemented12">
- </method>
</interface>
</node>
<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
-
<tp:struct name="EventListenerMode">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A structure that encapsulates the characteristics of the event notifications
that should be sent to an EventListener in response to a call to
- DeviceEventController::registerKeystrokeListener or
- DeviceEventController::registerDeviceEventListener. </p>
+ DeviceEventController.registerKeystrokeListener or
+ DeviceEventController.registerDeviceEventListener. </p>
</tp:docstring>
<tp:member type="b" tp:name="synchronous">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< If \c True, specifies that
+ <p>If \c <code>True</code>, specifies that
DeviceEventController should block while waiting
for client to process the requested event notifications;
ordinarily should be used only when client needs to perform
</tp:member>
<tp:member type="b" tp:name="preemptive">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< If \c True, specifies that
+ <p>If <code>True</code>, specifies that
Listener is allowed to pre-empt the delivery of the event,
- effectively "consuming" it such that it is not delivered
+ effectively 'consuming' it such that it is not delivered
to the currently focussed desktop application.
Key events consumed via this API will not be
available for use by other applications or services, so this
</tp:member>
<tp:member type="b" tp:name="global">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< If \c True, specifies that
+ <p>If <code>True</code>, specifies that
Event notifications should be sent regardless of whether the
currently focussed application participates in the AT-SPI
infrastructure. On systems with the XEvIE X extension, this flag
also allows access to events which are already subject to
- interception via a "system keygrab" (as described in the X Window System
+ interception via a 'system keygrab' (as described in the X Window System
documentation for XGrabKey). The 'global' and 'preemptive' flags
should only be used together for the purposes of registering
- "system global key shortcuts" i.e. command keys for use by the
+ 'system global key shortcuts' i.e. command keys for use by the
assistive technology. </p>
</tp:docstring>
</tp:member>
</tp:docstring>
<tp:member type="u" tp:name="type">
<tp:docstring>
- < Identifies the type of the containing DeviceEvent.
+ Identifies the type of the containing DeviceEvent.
</tp:docstring>
</tp:member>
<tp:member type="i" tp:name="id">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< an identifier which identifies this event in the event stream.
+ <p>An identifier which identifies this event in the event stream.
On X Window systems this corresponds to the XEvent serial number.</p>
</tp:docstring>
</tp:member>
<tp:member type="n" tp:name="hw_code">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< a numeric code which is hardware and system-dependent, identifying the
+ <p>A numeric code which is hardware and system-dependent, identifying the
specific hardware button or key on the device for which the event has
occurred. On X Window systems, for global key notifications and for most
non-global key notifications as well, this code corresponds to the
XKeycode. For switch and button events it indicates the switch
or button number.
- @note
+ </p>
+ <p>
For technical reasons, this code may differ from the XKeycode
when generated by Java applications for consumption by non-global
key listeners. This is subject to change in future versions of the
- DeviceEventController implementation.</p>
+ DeviceEventController implementation.
+ </p>
</tp:docstring>
</tp:member>
<tp:member type="n" tp:name="modifiers">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< an unsigned short int consisting of zero or more of the following
+ <p>An unsigned short int consisting of zero or more of the following
values OR'ed together:
- \li \c 1<<::MODIFIER_SHIFT (=1, corresponds to Xlib's ShiftMask)
- \li \c 1<<::MODIFIER_SHIFTLOCK (=2, corresponds to Xlib's LockMask)
- \li \c 1<<::MODIFIER_CONTROL (=4, corresponds to Xlib's ControlMask)
- \li \c 1<<::MODIFIER_ALT (=8, corresponds to Xlib's Mod1Mask)
- \li \c 1<<::MODIFIER_META (=16, corresponds to Xlib's Mod2Mask)
- \li \c 1<<::MODIFIER_META2 (=32, corresponds to Xlib's Mod3Mask)
- \li \c 1<<::MODIFIER_META3 (=64, corresponds to Xlib's Mod4Mask)</p>
+ <ol>
+ <li><code>MODIFIER_SHIFT</code> (=1, corresponds to Xlib's ShiftMask)</li>
+ <li><code>MODIFIER_SHIFTLOCK</code> (=2, corresponds to Xlib's LockMask)</li>
+ <li><code>MODIFIER_CONTROL</code> (=4, corresponds to Xlib's ControlMask)</li>
+ <li><code>MODIFIER_ALT</code> (=8, corresponds to Xlib's Mod1Mask)</li>
+ <li><code>MODIFIER_META</code> (=16, corresponds to Xlib's Mod2Mask)</li>
+ <li><code>MODIFIER_META2</code> (=32, corresponds to Xlib's Mod3Mask)</li>
+ <li><code>MODIFIER_META3</code> (=64, corresponds to Xlib's Mod4Mask)</li>
+ </ol>
+ </p>
</tp:docstring>
</tp:member>
<tp:member type="i" tp:name="timestamp">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< an unsigned integer representing the time that the
+ <p>An unsigned integer representing the time that the
event occurred. On X Window systems this event is
a time in milliseconds from some arbitrary starting
point; it therefore has a cycle time of approximately
</tp:member>
<tp:member type="s" tp:name="event_string">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< A string representation of the event. If is_text is
- \c True, then this string represents the character or typographic
+ <p>A string representation of the event. If is_text is
+ <code>True</code>, then this string represents the character or typographic
sequence that would be received by a focussed text input field.
event_string is in general suitable for exposure to the
end-user for purposes of keyboard echo.</p>
</tp:member>
<tp:member type="b" tp:name="is_text">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< \c True if the event results in the insertion of characters
+ <p><code>True</code> if the event results in the insertion of characters
into an input text buffer, or would do so if delivered to a focussed
- text input field. ¨Typographical¨ key events have this field set to
- \c True, whereas ¨control¨ key events generally do not.</p>
+ text input field. 'Typographical' key events have this field set to
+ <code>True</code>, whereas 'control' key events generally do not.</p>
</tp:docstring>
</tp:member>
</tp:struct>
<tp:struct name="KeyDefinition">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A structure which defines the identity of a key for which notifications
- are to be requested. The data in the members of a ::KeyDefinition are used to
+ are to be requested. The data in the members of a KeyDefinition are used to
determine which keyboard events 'match' the notification request filed by a client. </p>
- <p>@note Ordinarily a KeyDefinition specifies one and only one of the criteria below;
+ <p>Ordinarily a KeyDefinition specifies one and only one of the criteria below;
the result of using a KeyDefinition with multiple members defined as nonzero is
- undefined. </p>
+ undefined.</p>
- <p>@param keycode if nonzero, the numeric, system-dependent value corresponding to a
+ </tp:docstring>
+ <tp:member type="i" tp:name="keycode">
+ <tp:docstring>
+ If nonzero, the numeric, system-dependent value corresponding to a
physical key on the keyboard. Keycode values have no semantic meaning to the end-user,
and may depend on the user's hardware and operating environment. They therefore are
- rarely useful "as-is" to AT clients, unless the client has used operating system
+ rarely useful 'as-is' to AT clients, unless the client has used operating system
services to identify the hardward keycode associated with a particular key symbol.
Notifications for key events requested by keycode are less dependent on modifier state
- than \c keysym based notifications, but some hardware (notably many laptops) may generate
+ than <code>keysym</code> based notifications, but some hardware (notably many laptops) may generate
more than one keycode for the same physical key, depending on the state of physical
shift/modifier keys.
- @param keysym if nonzero, the numeric value corresponding to the X Keysym of the key for which
+ </tp:docstring>
+ </tp:member>
+ <tp:member type="i" tp:name="keysym">
+ <tp:docstring>
+ If nonzero, the numeric value corresponding to the X Keysym of the key for which
notification is requested. Note that the presence of active modifiers will affect
- whether notification for key events requested via "keysym" specification takes place,
+ whether notification for key events requested via 'keysym' specification takes place,
since the keysym depends on the modifier state for most keys.
- @param keystring if non-NULL, the string value of the inserted characters if the corresponding
- key event has ::KeyEvent:is_text set to \c True, or the string representing the
+ </tp:docstring>
+ </tp:member>
+ <tp:member type="s" tp:name="keystring">
+ <tp:docstring>
+ If non-NULL, the string value of the inserted characters if the corresponding
+ key event has KeyEvent:.is_text set to <code>True</code>, or the string representing the
'name' of the key. On X11 systems, the string 'name' of non-printing keysyms corresponds
- to the values in "keysymdef.h" as provided by Xlib, with the leading "XK_" stripped off.</p>
- </tp:docstring>
- <tp:member type="i" tp:name="keycode"/>
- <tp:member type="i" tp:name="keysym"/>
- <tp:member type="s" tp:name="keystring"/>
- <tp:member type="i" tp:name="unused"/>
+ to the values in 'keysymdef.h' as provided by Xlib, with the leading 'XK_'; stripped off.
+ </tp:docstring>
+ </tp:member>
</tp:struct>
<interface name="org.freedesktop.atspi.DeviceEventListener">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<arg direction="in" name="event" type="(uinnisb)" tp:type="DeviceEvent"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the recipient/consumer wishes to consume the event, i.e.prevent it from being delivered to the desktop, \c False if the event should continue to be delivered as normal.
+ <code>True</code> if the recipient/consumer wishes to consume the event, i.e.prevent it from being delivered to the desktop, <code>False</code> if the event should continue to be delivered as normal.
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
<tp:docstring>
- a DeviceEventListener which will intercept key events.
+ A DeviceEventListener which will intercept key events.
</tp:docstring>
</arg>
<arg direction="in" name="keys" type="a(iisi)" tp:type="KeySet">
<tp:docstring>
- a KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
+ A KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
</tp:docstring>
</arg>
<arg direction="in" name="mask" type="u" tp:type="ControllerEventMask">
<tp:docstring>
- a ControllerEventMask filtering the intercepted key events.
+ A ControllerEventMask filtering the intercepted key events.
</tp:docstring>
</arg>
<arg direction="in" name="type" type="au" tp:type="KeyEventTypeSeq">
<tp:docstring>
- a KeyEventTypeSeq that may created by ORing event types together.
+ A KeyEventTypeSeq that may created by ORing event types together.
</tp:docstring>
</arg>
<arg direction="in" name="mode" type="(bbb)" tp:type="EventListenerMode">
<tp:docstring>
- an EventListenerMode indicating whether the listener should receive the events synchronously, potentially consuming them,or just be notified asynchronously of those events that havebeen generated.@note Some platforms have limited support for global, preemptive EventListenerMode.Such a registration may fail if another client already has priority for preemptiveaccess to one or more of the members of the KeySet. AT consumers have the optionof re-trying the request without the global flag, or without the preemptive flag,or of re-trying with a different KeySet. The best support for pre-emptiveglobal keyboard listeners is provided on platforms whose Xserver implementationprovides the XEvIE extension.
+ An EventListenerMode indicating whether the listener should receive the events synchronously, potentially consuming them,or just be notified asynchronously of those events that havebeen generated.
+
+ Some platforms have limited support for global, preemptive EventListenerMode.Such a registration may fail if another client already has priority for preemptiveaccess to one or more of the members of the KeySet. AT consumers have the optionof re-trying the request without the global flag, or without the preemptive flag,or of re-trying with a different KeySet. The best support for pre-emptiveglobal keyboard listeners is provided on platforms whose Xserver implementationprovides the XEvIE extension.
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the DeviceEventListener was successfully registeredfor the requested KeySet, ControllerEventMask, event types, and EventListenerMode; otherwise returns \c False.
+ <code>True</code> if the DeviceEventListener was successfully registeredfor the requested KeySet, ControllerEventMask, event types, and EventListenerMode; otherwise returns <code>False</code>.
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
<tp:docstring>
- a DeviceEventListener which will intercept key events.
+ A DeviceEventListener which will intercept key events.
</tp:docstring>
</arg>
<arg direction="in" name="keys" type="a(iisi)" tp:type="KeySet">
<tp:docstring>
- a KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
+ A KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
</tp:docstring>
</arg>
<arg direction="in" name="mask" type="u" tp:type="ControllerEventMask">
<tp:docstring>
- a ControllerEventMask filtering the intercepted key events.
+ A ControllerEventMask filtering the intercepted key events.
</tp:docstring>
</arg>
<arg direction="in" name="type" type="au" tp:type="KeyEventTypeSeq">
<tp:docstring>
- an EventType mask that may created by ORing event types together.
+ An EventType mask that may created by ORing event types together.
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
<tp:docstring>
- a DeviceEventListener which will intercept events.
+ A DeviceEventListener which will intercept events.
</tp:docstring>
</arg>
<arg direction="in" name="types" type="u" tp:type="EventTypeSeq">
<tp:docstring>
- an EventTypeSeq indicating which event types to listen for.
+ An EventTypeSeq indicating which event types to listen for.
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if successful, \c False if not
+ <code>True</code> if successful, <code>False</code> if not
</tp:docstring>
</arg>
</method>
</arg>
<arg direction="in" name="types" type="u" tp:type="EventTypeSeq">
<tp:docstring>
- an EventTypeSeq indicating which event types to stoplistening for.
+ An EventTypeSeq indicating which event types to stoplistening for.
</tp:docstring>
</arg>
</method>
<p>Notify the Registry instance that a device event has taken place, and
allow pre-emptive listeners the opportunity to 'consume' the event
and thus prevent its further issuance/forwarding. This is the
- method used by accessibility bridges to forward "toolkit dependent"
- device events to the Registry from the application's process space. </p>
+ method used by accessibility bridges to forward 'toolkit dependent'
+ device events to the Registry from the application's process space.</p>
- <p>@note AT clients do not normally need to use this method, it is intended for use
- by toolkit bridges and special-purpose applications. </p>
+ <p>AT clients do not normally need to use this method, it is intended for use
+ by toolkit bridges and special-purpose applications.</p>
</tp:docstring>
<arg direction="in" name="event" type="(uinnisb)" tp:type="DeviceEvent"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the event was consumed by a (pre-emptive) listener,\c False if not (in which case the device event will be forwardedas normal to any application which would normally receive it, e.g.the currently active application in the case of mouse or keyboard events).
+ <code>True</code> if the event was consumed by a (pre-emptive) listener, <code>False</code> if not (in which case the device event will be forwardedas normal to any application which would normally receive it, e.g.the currently active application in the case of mouse or keyboard events).
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Notify the Registry instance that a device event has taken place in
an asynchronous manner. This is the
- method used by accessibility bridges to forward "toolkit dependent"
+ method used by accessibility bridges to forward 'toolkit dependent'
device events to the Registry from the application's process space.
If the event in question is potentially pre-emptible.
- ::notifyListenersSync should be used instead. </p>
+ notifyListenersSync should be used instead.</p>
- <p>@note AT clients do not normally need to use this method, it is intended for use
+ <p>AT clients do not normally need to use this method, it is intended for use
by toolkit bridges and special-purpose applications.</p>
</tp:docstring>
<arg direction="in" name="event" type="(uinnisb)" tp:type="DeviceEvent"/>
</tp:docstring>
<arg direction="in" name="keycode" type="i">
<tp:docstring>
- a long integer indicating the keycode ofthe keypress to be synthesized.
+ A long integer indicating the keycode ofthe keypress to be synthesized.
</tp:docstring>
</arg>
<arg direction="in" name="keystring" type="s">
<tp:docstring>
- an optional UTF-8 string indicating a complexkeyboard input event.
+ An optional UTF-8 string indicating a complexkeyboard input event.
</tp:docstring>
</arg>
<arg direction="in" name="type" type="u" tp:type="KeySynthType">
<tp:docstring>
- a KeySynthType indicating the type of event(s) to be synthesized: a key press, release, press-release pair,or a complex input string (for instance from aninternationalized or complex text input method, ora composed character).@note keycode may be truncated before beingprocessed, as keycode length may be platform-dependentand keycode ranges are generally much smaller thanCORBA_long. One or the other of keycode or keystring are generally NULL, (but not both), depending on the value of \c type.
+ <p>A KeySynthType indicating the type of event(s) to be synthesized: a key press, release, press-release pair,or a complex input string (for instance from aninternationalized or complex text input method, ora composed character).</p>
+
+ <p>Keycode may be truncated before beingprocessed, as keycode length may be platform-dependentand keycode ranges are generally much smaller thanCORBA_long. One or the other of keycode or keystring are generally NULL, (but not both), depending on the value of <code>type</code>.</p>
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="in" name="x" type="i">
<tp:docstring>
- a long integer indicating the screen x coord for the mouse event.
+ A long integer indicating the screen x coord for the mouse event.
</tp:docstring>
</arg>
<arg direction="in" name="y" type="i">
<tp:docstring>
- a long integer indicating the screen y coord for the mouse event.
+ A long integer indicating the screen y coord for the mouse event.
</tp:docstring>
</arg>
<arg direction="in" name="eventName" type="s">
<tp:docstring>
- a string indicating the type of mouse event, e.g. "button1up"
+ A string indicating the type of mouse event, e.g. 'button1up'.
</tp:docstring>
</arg>
</method>
<?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.Hyperlink">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Instances of Hyperlink are returned by Hypertext objects, and are
anchors. The objects thus obtained are instances of Accessible,
and may be queried, and manipulated via the Action interface. </p>
- <p>@note A Hyperlink implementor is normally NOT an Accessible;
- the preferred usage is for a Hyperlink's associated "objects"
- (accessed via the ::getObject method) are Accessibles. This means
- that Actions such as "open link" are normally invoked on
- the result of Hyperlink::getObject rather than directly on the
+ <p>A Hyperlink implementor is normally NOT an Accessible;
+ the preferred usage is for a Hyperlink's associated 'objects'
+ (accessed via the getObject method) are Accessibles. This means
+ that Actions such as 'open link' are normally invoked on
+ the result of Hyperlink.getObject rather than directly on the
Hyperlink instance. For historical reasons some implementors of Hyperlink
implement Action as well. This usage on the part of implementing
applications and toolkits is discouraged, but clients of Hyperlink
</tp:docstring>
<tp:property name="nAnchors" type="n" access="read">
<tp:docstring>
- the number of separate anchors associated with this Hyperlink
+ The number of separate anchors associated with this Hyperlink
</tp:docstring>
</tp:property>
<tp:property name="startIndex" type="i" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>the starting offset within the containing Hypertext content
+ <p>The starting offset within the containing Hypertext content
with which this Hyperlink is associated </p>
</tp:docstring>
</tp:property>
<tp:property name="endIndex" type="i" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>the ending offset within the containing Hypertext content
+ <p>The ending offset within the containing Hypertext content
with which this Hyperlink is associated; that is, the offset of the
first element past the range within the Hypertext associated with
this Hyperlink. </p>
<method name="getObject">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Gets the i'th object, (where i is an integer between 0 and
- Hyperlink::numAnchors - 1, inclusive) associated with a Hyperlink.
+ Hyperlink.numAnchors - 1, inclusive) associated with a Hyperlink.
The objects returned are usually actionable (i.e. they should implement
- Accessibility::Action), and the available actions often include
- "open", "bookmark", "save link as", etc. They may also implement
- Accessibility::StreamableContent, although clients can normally use
- ::getURI to obtain a resource locator via which the object's
+ Accessibility.Action), and the available actions often include
+ 'open', 'bookmark', 'save link as', etc. They may also implement
+ Accessibility.StreamableContent, although clients can normally use
+ getURI to obtain a resource locator via which the object's
data may be accessed. </p>
- <p>@note the most common application for 'multi anchor'
- hyperlinks in HTML is probably "client side imagemaps".
+ <p>The most common application for 'multi anchor'
+ hyperlinks in HTML is probably 'client side imagemaps'.
A clickable image which uses the HTML 'usemap' attribute
- should have one anchor for every <area> element that
+ should have one anchor for every area; element that
includes an HREF. The objects corresponding to these map
- areas may implement Accessibility::Component, to represent
+ areas may implement Accessibility.Component, to represent
their onscreen bounding box, and may expose their 'shape' as
- as name-value pair via Accessibility::Accessible::getAttributeSet. </p>
+ as name-value pair via Accessible.getAttributeSet.</p>
</tp:docstring>
<arg direction="in" name="i" type="i"/>
<arg direction="out" type="o" tp:type="Accessible">
<tp:docstring>
- an Accessible object instance representing theHyperlink's ith anchor, or through which the content associated withthe \c ith anchor can beaccessed.
+ An Accessible object instance representing theHyperlink's ith anchor, or through which the content associated with the ith anchor can beaccessed.
</tp:docstring>
</arg>
</method>
<arg direction="in" name="i" type="i"/>
<arg direction="out" type="s">
<tp:docstring>
- a string corresponding to the URI of the Hyperlink's'ith' anchor, if one exists, or a NIL string otherwise.
+ A string corresponding to the URI of the Hyperlink's'ith' anchor, if one exists, or a NIL string otherwise.
</tp:docstring>
</arg>
</method>
<method name="isValid">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Check the hyperlink to see if a connection to its backing
- content can be established, or if its URI is valid.
- @note instances of invalid hyperlinks include links with malformed
+ content can be established, or if its URI is valid. </p>
+ <p>Instances of invalid hyperlinks include links with malformed
URIs, or for which a contact to the service provider
specified in the URI cannot be established.</p>
</tp:docstring>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the object's content is available, or\c False if the hyperlink's URI is invalid, or a connection to the resource can not be established.
+ <code>True</code> if the object's content is available, or\c False if the hyperlink's URI is invalid, or a connection to the resource can not be established.
</tp:docstring>
</arg>
</method>
- <method name="unImplemented">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>\cond
- unImplemented: </p>
-
- <p>placeholders for future expansion.</p>
- </tp:docstring>
- </method>
- <method name="unImplemented2">
- </method>
- <method name="unImplemented3">
- </method>
- <method name="unImplemented4">
- </method>
</interface>
</node>
<?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.Hypertext">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface used for objects which implement linking between
one or more Hyperlinks, which are associated with particular
offsets within the Hypertext's included content. </p>
- <p>@note While this interface is derived from ::Text,
+ <p>While this interface is derived from Text,
there is no requirement that Hypertext instances have
- textual content; they may implement ::Image as well,
+ textual content; they may implement Image as well,
and Hyperlinks need not have non-zero text offsets.</p>
</tp:docstring>
<method name="getNLinks">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Query the hypertext object for the number of Hyperlinks it
- contains. </p>
+ contains.</p>
</tp:docstring>
<arg direction="out" type="i">
<tp:docstring>
- the number of Hyperlinks associated with this Hypertextobject, as a long integer.
+ The number of Hyperlinks associated with this Hypertextobject, as a long integer.
</tp:docstring>
</arg>
</method>
<method name="getLink">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get one of the Hyperlinks associated with this Hypertext object,
- by index. </p>
-
- <p>@param linkIndex an integer from 0 to getNLinks() - 1.</p>
+ by index.</p>
</tp:docstring>
- <arg direction="in" name="linkIndex" type="i"/>
+ <arg direction="in" name="linkIndex" type="i">
+ <tp:docstring>
+ <p>An integer from 0 to getNLinks() - 1.</p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="o" tp:type="Hyperlink">
<tp:docstring>
- the Hyperlink in this Hypertext object.
+ The Hyperlink in this Hypertext object.
</tp:docstring>
</arg>
</method>
For Hypertext implementors without textual content, all
hyperlinks are associated with character offset '0'. </p>
- <p>@return the index of the Hyperlink associated with character
- offset \c characterIndex, or -1 if no Hyperlink is associated
- with that character offset.</p>
</tp:docstring>
<arg direction="in" name="characterIndex" type="i"/>
- <arg direction="out" type="i"/>
- </method>
- <method name="unImplemented">
- <tp:docstring>
- \cond
- </tp:docstring>
- </method>
- <method name="unImplemented2">
- </method>
- <method name="unImplemented3">
- </method>
- <method name="unImplemented4">
+ <arg direction="out" type="i">
+ <tp:docstring>
+ <p>The index of the Hyperlink associated with character
+ offset <code>characterIndex</code>, or -1 if no Hyperlink is associated
+ with that character offset.
+ </p>
+ </tp:docstring>
+ </arg>
</method>
</interface>
</node>
<?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.Image">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface implemented by objects which render image data or
or visual layout, but which conveys some semantic or informational
content to the sighted user, they should implement Image, and that
semantic content should be conveyed textually to the extent possible
- via the image description, as well as the Accessible::name and
- Accessible::description properties. </p>
+ via the image description, as well as the Accessible.name and
+ Accessible.description properties. </p>
</tp:docstring>
<tp:property name="imageDescription" type="s" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A UTF-8 string providing a textual description
of what is visually depicted in the image. </p>
- <p>@note It is recommended that imageDescription be the shorter
+ <p>It is recommended that imageDescription be the shorter
of the available image descriptions, for instance "alt text"
in HTML images, and a longer description be provided in
- Accessible::accessible-description, if available.
+ Accessible.description, if available.
A short, one or two word label for the image should be provided in
- Accessible::accessible-name.</p>
+ Accessible.name.</p>
</tp:docstring>
</tp:property>
<tp:property name="imageLocale" type="s" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A string corresponding to the POSIX LC_MESSAGES locale used
- by the imageDescription.
- @since AT-SPI 1.7.0</p>
+ by the imageDescription.</p>
</tp:docstring>
</tp:property>
<method name="getImageExtents">
as displayed on screen. The bounds returned do not account for
any viewport clipping or the fact that the image may be
partially or wholly obscured by other onscreen content.
- @note This method returns the bounds of the current onscreen
+ </p>
+ <p>This method returns the bounds of the current onscreen
view, and not the nominal size of the source data in the
event that the original image has been rescaled. </p>
-
- <p>@param coordType If 0, the returned bounding box position is returned
+ </tp:docstring>
+ <arg direction="in" name="coordType" type="n" tp:type="short">
+ <tp:docstring>
+ <p>If 0, the returned bounding box position is returned
relative to the screen; if 1, the bounding box position is returned
relative to the containing window.</p>
- </tp:docstring>
- <arg direction="in" name="coordType" type="n" tp:type="short"/>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="(iiii)" tp:type="BoundingBox">
<tp:docstring>
- a BoundingBox enclosing the image's onscreen representation.
+ A BoundingBox enclosing the image's onscreen representation.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get the coordinates of the current image position on screen. </p>
- <p>@param x Back-filled with the x coordinate of the
+ </tp:docstring>
+ <arg direction="out" name="x" type="i">
+ <tp:docstring>
+ Back-filled with the x coordinate of the
onscreen image (i.e. the minimum x coordinate)
- @param y Back-filled with the y coordinate of the
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="y" type="i">
+ <tp:docstring>
+ Back-filled with the y coordinate of the
onscreen image (i.e. the minimum y coordinate)
- @param coordType If 0, the returned x and y coordinates are
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="coordType" type="n" tp:type="short">
+ <tp:docstring>
+ If 0, the returned x and y coordinates are
returned relative to the screen;
- if 1, they are returned relative to the containing window.</p>
- </tp:docstring>
- <arg direction="out" name="x" type="i"/>
- <arg direction="out" name="y" type="i"/>
- <arg direction="in" name="coordType" type="n" tp:type="short"/>
+ if 1, they are returned relative to the containing window.
+ </tp:docstring>
+ </arg>
</method>
<method name="getImageSize">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
image. The extents returned do not account for
any viewport clipping or the fact that the image may be
partially or wholly obscured by other onscreen content.
- @note This method returns the size of the current onscreen
+ </p>
+ <p>This method returns the size of the current onscreen
view, and not the nominal or "original" size of the source
- image, in the event that the original image has been rescaled. </p>
-
- <p>@param width Back-filled with the x extents of the
- onscreen image (i.e. the image width in pixels)
- @param height Back-filled with the y extents of the
- onscreen image (i.e. the image height in pixels)</p>
- </tp:docstring>
- <arg direction="out" name="width" type="i"/>
- <arg direction="out" name="height" type="i"/>
- </method>
- <method name="unImplemented">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>\cond
- unImplemented: </p>
+ image, in the event that the original image has been rescaled.
+ </p>
- <p>placeholders for future expansion.</p>
</tp:docstring>
- </method>
- <method name="unImplemented2">
- </method>
- <method name="unImplemented3">
+ <arg direction="out" name="width" type="i">
+ <tp:docstring>
+ Back-filled with the x extents of the
+ onscreen image (i.e. the image width in pixels)
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="height" type="i">
+ <tp:docstring>
+ Back-filled with the y extents of the
+ onscreen image (i.e. the image height in pixels)
+ </tp:docstring>
+ </arg>
</method>
</interface>
</node>
<?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.LoginHelper">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>@brief An interface for use by assistive technologies by which
</tp:docstring>
</arg>
</method>
- <method name="unImplemented">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>\cond
- unImplemented: </p>
-
- <p>placeholders for future expansion.</p>
- </tp:docstring>
- </method>
- <method name="unImplemented2">
- </method>
- <method name="unImplemented3">
- </method>
- <method name="unImplemented4">
- </method>
</interface>
</node>
projects / platform / core / uifw / at-spi2-atk.git / commitdiff