<xi:include href="org.freedesktop.atspi.Application.xml"/>
<xi:include href="org.freedesktop.atspi.Registry.xml"/>
-<xi:include href="org.freedesktop.atspi.Registry.Common.xml"/>
-<xi:include href="org.freedesktop.atspi.Event.xml"/>
+<xi:include href="org.freedesktop.atspi.DeviceEvent.xml"/>
<xi:include href="org.freedesktop.atspi.Desktop.xml"/>
<xi:include href="org.freedesktop.atspi.DeviceEventController.xml"/>
<xi:include href="org.freedesktop.atspi.DeviceEventListener.xml"/>
org.freedesktop.atspi.Hypertext.xml \
org.freedesktop.atspi.Image.xml \
org.freedesktop.atspi.LoginHelper.xml \
- org.freedesktop.atspi.Registry.Common.xml \
+ org.freedesktop.atspi.DeviceEvent.xml \
org.freedesktop.atspi.Registry.xml \
org.freedesktop.atspi.DeviceEventController.xml \
org.freedesktop.atspi.DeviceEventListener.xml \
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
-
-
-
-
-
<tp:enum name="KeyEventType" type="u">
<tp:docstring>
Deprecated, DO NOT USE!
-<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>
- </tp:docstring>
- <tp:member type="b" tp:name="synchronous">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <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
- operations synchronously with event delivery. Note that because
- of the architecture of device event systems in general,
- use of this flag may not block delivery of the event to
- the currently focussed application unless it is used in
- conjunction with the preemptive flag. </p>
- </tp:docstring>
- </tp:member>
- <tp:member type="b" tp:name="preemptive">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <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
- 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
- option should be used sparingly. </p>
- </tp:docstring>
- </tp:member>
- <tp:member type="b" tp:name="global">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <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
- 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
- assistive technology. </p>
- </tp:docstring>
- </tp:member>
-</tp:struct>
-<tp:struct name="DeviceEvent">
- <tp:docstring>
- A structure which encapsulates information about a device event.
- </tp:docstring>
- <tp:member type="u" tp:name="type">
- <tp:docstring>
- 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.
- 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
- 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.
- </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>
- </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
- values OR'ed together:
- <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
- 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
- 50 days.</p>
- </tp:docstring>
- </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
- <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:docstring>
- </tp:member>
- <tp:member type="b" tp:name="is_text">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <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
- <code>True</code>, whereas 'control' key events generally do not.</p>
- </tp:docstring>
- </tp:member>
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+<tp:struct name="Event">
+ <tp:docstring>
+ The generic application event structure. The event source is specified by the D-Bus path
+ and Bus-Name fields in the header of the D-Bus message.
+ </tp:docstring>
+ <tp:member type="s" tp:name="minor"/>
+ <tp:member type="u" tp:name="detail"/>
+ <tp:member type="u" tp:name="detail1"/>
+ <tp:member type="v" tp:name="any_data"/>
</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
- determine which keyboard events 'match' the notification request filed by a client. </p>
- <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>
+<interface name="org.freedesktop.atspi.Event.Object">
+ <signal name="property-change"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="bounds-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="link-selected"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="state-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="children-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="visible-data-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="selection-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="model-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="active-descendant-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="row-inserted"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="row-reordered"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="row-deleted"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="column-inserted"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="column-reordered"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="column-deleted"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="text-bounds-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="text-selection-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="text-changed'"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="text-attributes-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="text-caret-moved"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="attributes-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="text-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+</interface>
- </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
- 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 <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.
- </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,
- since the keysym depends on the modifier state for most keys.
- </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.
- </tp:docstring>
- </tp:member>
-</tp:struct>
-<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
- make use of the DeviceEventController to receive device event notifications.
- DeviceEvents include keyboard events and mouse button/motion events.</p>
- </tp:docstring>
- <method name="notifyEvent">
- <tp:docstring>
- Notify an interested DeviceEventListener that a DeviceEvent has occurred.
- </tp:docstring>
- <arg direction="in" name="event" type="(uinnisb)" tp:type="DeviceEvent"/>
- <arg direction="out" type="b" tp:type="boolean">
- <tp:docstring>
- <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>
+<interface name="org.freedesktop.atspi.Event.Window">
+ <signal name="property-change"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="minimize"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="maximize"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="restore"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="close"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="create"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="reparent"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="desktop-create"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="desktop-destroy"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="activate"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="deactivate"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="raise"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="lower"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="move"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="resize"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="shade"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="unshade"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="restyle"><arg direction="out" type="suuv" tp:type="Event"/></signal>
</interface>
-<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
- through which device events may be simulated.</p>
- </tp:docstring>
- <method name="registerKeystrokeListener">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Register to intercept keyboard events, and either pass them on or
- consume them. </p>
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
- <tp:docstring>
- 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.
- </tp:docstring>
- </arg>
- <arg direction="in" name="mask" type="u" tp:type="ControllerEventMask">
- <tp:docstring>
- 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.
- </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.
-
- 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>
- <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>
- <method name="deregisterKeystrokeListener">
- <tp:docstring>
- De-register a previously registered keyboard eventlistener.
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
- <tp:docstring>
- 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.
- </tp:docstring>
- </arg>
- <arg direction="in" name="mask" type="u" tp:type="ControllerEventMask">
- <tp:docstring>
- 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.
- </tp:docstring>
- </arg>
- </method>
- <method name="registerDeviceEventListener">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Register to intercept events, and either pass them on or
- consume them. To listen to keyboard events use registerKeystrokeListener
- instead.</p>
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
- <tp:docstring>
- 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.
- </tp:docstring>
- </arg>
- <arg direction="out" type="b" tp:type="boolean">
- <tp:docstring>
- <code>True</code> if successful, <code>False</code> if not
- </tp:docstring>
- </arg>
- </method>
- <method name="deregisterDeviceEventListener">
- <tp:docstring>
- De-register a previously registered keyboard eventlistener.
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
- <tp:docstring>
- 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 stoplistening for.
- </tp:docstring>
- </arg>
- </method>
- <method name="notifyListenersSync">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <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>
- <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>
- <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 name="notifyListenersAsync">
- <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'
- 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>
+<interface name="org.freedesktop.atspi.Event.Mouse">
+ <signal name="abs"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="rel"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="button"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+</interface>
- <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"/>
- </method>
- <method name="generateKeyboardEvent">
- <tp:docstring>
- Synthesize a keyboard event.
- </tp:docstring>
- <arg direction="in" name="keycode" type="i">
- <tp:docstring>
- 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.
- </tp:docstring>
- </arg>
- <arg direction="in" name="type" type="u" tp:type="KeySynthType">
- <tp:docstring>
- <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>
+<interface name="org.freedesktop.atspi.Event.Terminal">
+ <signal name="line-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="comumncount-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="linecount-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="application-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="charwidth-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+</interface>
+
+<interface name="org.freedesktop.atspi.Event.Document">
+ <signal name="load-complete"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="reload"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="load-stopped"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="content-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+ <signal name="attributes-changed"><arg direction="out" type="suuv" tp:type="Event"/></signal>
+</interface>
- <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>
- <method name="generateMouseEvent">
- <tp:docstring>
- Synthesize a mouse event.
- </tp:docstring>
- <arg direction="in" name="x" type="i">
- <tp:docstring>
- 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.
- </tp:docstring>
- </arg>
- <arg direction="in" name="eventName" type="s">
- <tp:docstring>
- A string indicating the type of mouse event, e.g. 'button1up'.
- </tp:docstring>
- </arg>
- </method>
+<interface name="org.freedesktop.atspi.Event.Focus">
+ <signal name="focus"><arg direction="out" type="suuv" tp:type="Event"/></signal>
</interface>
+
</node>
<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
+ <p>An interface for use by assistive technologies by which
they can access system information and services on a 'need to know'
basis while the screen is locked, during user authentication, or
during other sensitive operations. </p>
service. </p>
<p>Such 'applications' (for instance, screen lock dialogs and
- security-enabled web browsers) use the ::LoginHelper client
+ security-enabled web browsers) use the LoginHelper client
interfaces, and the bonobo-activation query service, to
- query for assistive technologies which advertise the ::LoginHelper
+ query for assistive technologies which advertise the LoginHelper
service. The client then queries these assistive technologies
- for their device I/O requirements, via the ::getDeviceReqs call.
- The client may then issue the advisory request ::setSafe (TRUE),
- which requests that the ::LoginHelper -implementing service make a
+ for their device I/O requirements, via the getDeviceReqs call.
+ The client may then issue the advisory request setSafe (TRUE),
+ which requests that the LoginHelper -implementing service make a
best-effort attempt to make itself more secure (for instance,
an onscreen keyboard might turn off word prediction, and a
screenreader may turn off keyboard echo via speech). The return
- value of ::setSafe is an advisory indication of whether this attempt
+ value of setSafe is an advisory indication of whether this attempt
was successful (no specific guarantees are implied).
Once the 'security sensitive' state is exited, the client should
- call ::setSafe (FALSE). </p>
+ call setSafe (FALSE). </p>
- <p>The return values from ::getDeviceReqs inform the client of which
- services the ::LoginHelper service (e. g. assistive technology) needs
+ <p>The return values from getDeviceReqs inform the client of which
+ services the LoginHelper service (e. g. assistive technology) needs
in order to do its job. The client may use this information to
loosen any restrictions on access which it may currently have in
place (for instance, keyboard grabs, etc.). If it does not do so,
<tp:struct name="WindowInfo">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A structure containing info about toplevel X windows that
- the ::LoginHelper instance wishes to have raised. </p>
+ the LoginHelper instance wishes to have raised. </p>
</tp:docstring>
<tp:member type="i" tp:name="winID">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>string display;
- short screen; </p>
- </tp:docstring>
</tp:member>
</tp:struct>
<tp:enum name="DeviceReq" type="u">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>DeviceReq: </p>
-
<p>The system and device access and services which the LoginHelper-implementing
assistive technology requires in order to enable the user to use the system. </p>
</tp:docstring>
<tp:enumvalue suffix="GUI_EVENTS">
<tp:docstring>
- !<: Needs access to the GUI event subsystem (e.g. Xserver)
+ Needs access to the GUI event subsystem (e.g. Xserver)
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="CORE_KEYBOARD" value="1">
<tp:docstring>
- !<: Needs access to the system keyboard events (read and write)
+ Needs access to the system keyboard events (read and write)
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="CORE_POINTER" value="2">
<tp:docstring>
- !<: Needs access to the onscreen pointer (e.g. mouse pointer)
+ Needs access to the onscreen pointer (e.g. mouse pointer)
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="EXT_INPUT" value="3">
<tp:docstring>
- !<: Reads XInput extended input devices
+ Reads XInput extended input devices
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="POST_WINDOWS" value="4">
<tp:docstring>
- !<: Posts Windows, and needs for toplevel windows to be visible
+ Posts Windows, and needs for toplevel windows to be visible
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="AUDIO_OUT" value="5">
<tp:docstring>
- !<: Writes to audio device
+ Writes to audio device
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="AUDIO_IN" value="6">
<tp:docstring>
- !<: Reads from audio device
+ Reads from audio device
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="NETWORK" value="7">
<tp:docstring>
- !<: Requires access to general network services, including remote access
+ Requires access to general network services, including remote access
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="LOCALHOST" value="8">
<tp:docstring>
- !<: Requires network services hosted on LOCALHOST only
+ Requires network services hosted on LOCALHOST only
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="SERIAL_OUT" value="9">
<tp:docstring>
- !<: Writes to a serial port
+ Writes to a serial port
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="SERIAL_IN" value="10">
</tp:docstring>
<arg direction="in" name="safe_mode" type="b" tp:type="boolean">
<tp:docstring>
- \c TRUE if the client is requesting that 'safe mode' be initiated, \c FALSE if the client is advising that 'safe mode' may beexited, i.e. normal operation may be resumed.Request a LoginHelper to enter "safe" mode, orinform LoginHelper that "safe" mode may be exited.If \a safe_mode is \c TRUE, but the return value is \c FALSE,the requesting client may wish to deny services to the ::LoginHelper, for instance avoid raising its toplevels.The return value is purely advisory, and no guarantees are intended about what the implementing LoginHelper will do to improve security when in "safe" mode.
+ <code>True</code> if the client is requesting that 'safe mode' be initiated.
+ <code>False</code> if the client is advising that 'safe mode' may be
+ exited. i.e. Normal operation may be resumed.
+
+ Request a LoginHelper to enter "safe" mode, orinform LoginHelper that "safe" mode may be exited.
+ If safe_mode is <code>True</code>, but the return value is <code>False</code> ,the requesting
+ client may wish to deny services to the LoginHelper, for instance avoid raising its toplevels.
+ The return value is purely advisory, and no guarantees are intended about what the implementing
+ LoginHelper will do to improve security when in "safe" mode.
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- whether the ::LoginHelper is now "safe" or not.
+ whether the LoginHelper is now "safe" or not.
</tp:docstring>
</arg>
</method>
<method name="getDeviceReqs">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>getDeviceReqs: </p>
-
- <p>Query a ::LoginHelper for the types of
+ <p>Query a LoginHelper for the types of
device I/O it requires, in order to do its job.
- For instance, a ::LoginHelper which needs to receive keyboard
+ For instance, a LoginHelper which needs to receive keyboard
events will include
Accessibility_LoginHelper_CORE_KEYBOARD in this list. </p>
</tp:docstring>
<arg direction="out" type="u" tp:type="DeviceReqList">
<tp:docstring>
- A sequence of ::LoginHelper_DeviceReq indicatingthe device I/O required in order to facilitate end-user access to the system.
+ A sequence of LoginHelper_DeviceReq indicatingthe device I/O required in order to facilitate end-user
+ access to the system.
</tp:docstring>
</arg>
</method>
<method name="getRaiseWindows">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>getRaiseWindows: </p>
-
- <p>Get a list of window IDs that need raising on login. </p>
+ <p>Get a list of window IDs that need raising on login.</p>
</tp:docstring>
<arg direction="out" type="ai" tp:type="WindowList">
<tp:docstring>
- a sequence containing window IDS for toplevels whichneed to be raised/made visible during user authentication, inorder for the ::LoginHelper to facilitate end-user access to the system.
+ A sequence containing window IDS for toplevels whichneed to be raised/made
+ visible during user authentication, inorder for the LoginHelper to facilitate
+ end-user access to the system.
</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.Registry">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The Registry is a service through which applications providing
interact with those applications. </p>
<p>The Registry service provides four basic functions to Assistive Technology (AT) clients:
- \li it provides a list of the applications who have registered with the AT-SPI
- framework, thereby announcing their participation in the AT-SPI framework;
- \li it allows AT clients to register for notification of changes in application
- state (at-spi Events);
- \li it dispatches/relays said events from participating applications to
- the registered listeners;
- \li it gives access to system device events via the associated DeviceEventController
- interface. </p>
+ <ol>
+ <li>It provides a list of the applications who have registered with the
+ AT-SPI framework, thereby announcing their participation in the AT-SPI framework.</li>
+ <li>It gives access to system device events via the associated DeviceEventController interface.</li>
+ </ol>
+ </p>
<p>From the point of view of accessible applications (i.e. AT-SPI service producers),
the Registry is primarily a registration and event delivery service. Applications
normally only call the registerApplication and deregisterApplication Registry methods,
and its inherited EventListener::notifyEvent method. </p>
- <p>@note Although all application events are dispatched via the Registry, other AT client
+ <p>Although all application events are dispatched via the Registry, other AT client
calls are serviced directly by the applications, rather than being relayed via the
Registry. The AT client obtains references to these application objects
via the enumeration of Desktop instances whose children are Application instances
- (Registry::getDesktopList) and via examination of the 'source' member of the Event
+ (Registry.getDesktopList) and via examination of the 'source' member of the Event
structure. </p>
<p>The Registry normally lives in its own process space; communication via Registry and
both application services and AT clients takes place via IPC. A process space diagram
- illustrating the relationship between applications, Registry, and AT is shown below.
- @image html "http://developer.gnome.org/projects/gap/tech-docs/SPIBlockDiagram.png" </p>
-
- <p>@see Desktop, Application, Event, EventListener</p>
+ illustrating the relationship between applications, Registry, and AT is shown at:
+ http://developer.gnome.org/projects/gap/tech-docs/SPIBlockDiagram.png </p>
</tp:docstring>
<method name="registerApplication">
<tp:docstring>
</tp:docstring>
<arg direction="in" name="app" type="o" tp:type="Application">
<tp:docstring>
- a reference to the Application to be deregistered.
+ A reference to the Application to be deregistered.
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="in" name="listener" type="o" tp:type="EventListener">
<tp:docstring>
- a reference to the requesting ::EventListener.
+ A reference to the requesting EventListener.
</tp:docstring>
</arg>
<arg direction="in" name="eventName" type="s">
<tp:docstring>
- a string which indicates the type of events about which the client desires notification.
+ A string which indicates the type of events about which the client desires notification.
</tp:docstring>
</arg>
</method>
<method name="deregisterGlobalEventListenerAll">
- <tp:docstring>
- deregisterGlobalEventListenerAll:
- </tp:docstring>
<arg direction="in" name="listener" type="o" tp:type="EventListener">
<tp:docstring>
- the requesting EventListenerRequest that a previously registered client stop receivingglobal notifications for all events for which it was registered.
+ The requesting EventListenerRequest that a previously registered client stop receiving global notifications for all events for which it was registered.
</tp:docstring>
</arg>
</method>
<method name="deregisterGlobalEventListener">
- <tp:docstring>
- deregisterGlobalEventListener:
- </tp:docstring>
<arg direction="in" name="listener" type="o" tp:type="EventListener">
<tp:docstring>
- the requesting EventListener
+ The requesting EventListener
</tp:docstring>
</arg>
<arg direction="in" name="eventName" type="s">
<tp:docstring>
- a string indicating the type of eventsRequest that a previously registered client stop receivingglobal notifications for events of a certain type.
+ A string indicating the type of eventsRequest that a previously registered client stop receiving global notifications for events of a certain type.
</tp:docstring>
</arg>
</method>
<method name="getDesktopCount">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>event types: "Window" "Desktop"
+ <p>Event types: "Window" "Desktop"
"Window:Create" "Window:Destroy"
"Window:Iconify" "Window:Restore"
"Window:Fullscreen" "Window:Resize"
"Desktop:Reorder"
"Focus"
"GtkWidget:show"
- "GObject:notify:<propertyname>" </p>
+ "GObject:notify:propertyname" </p>
<p>( not sure we should allow these last 2 forms,
since they are toolkit-specific, but they're powerful ) </p>
- <p>getDesktopCount: </p>
-
<p>Get the current number of desktops.</p>
</tp:docstring>
<arg direction="out" type="n" tp:type="short">
<tp:docstring>
- a short integer indicating the current number of Desktops.
+ A short integer indicating the current number of Desktops.
</tp:docstring>
</arg>
</method>
<method name="getDesktop">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>getDesktop:
- @n: the index of the requested Desktop. </p>
-
<p>Get the nth accessible desktop. </p>
</tp:docstring>
<arg direction="in" name="n" type="n" tp:type="short"/>
<arg direction="out" type="o" tp:type="Desktop">
<tp:docstring>
- a reference to the requested Desktop.
+ A reference to the requested Desktop.
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="out" type="as" tp:type="DesktopSeq">
<tp:docstring>
- a sequence containing references tothe Desktops.
+ A sequence containing references tothe Desktops.
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="out" type="o" tp:type="DeviceEventController">
<tp:docstring>
- an object implementing DeviceEventController
+ An object implementing DeviceEventController
</tp:docstring>
</arg>
</method>
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
-
-
-
-
-
<tp:enum name="RelationType" type="u">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>RelationType specifies a relationship between objects (possibly one-to-many or many-to-one)
that should accompany the accessibleName property when presenting an object's content or identity
to the end user. Similarly, RELATION_CONTROLLER_FOR can be used to further specify the context
in which a valuator is useful, and/or the other UI components which are directly effected by
- user interactions with the valuator. Common examples include association of scrollbars with
+ user interactions with the valuator. Common examples include association of scrollbars with
the viewport or panel which they control.</p>
</tp:docstring>
<tp:enumvalue suffix="RELATION_NULL">
</tp:enumvalue>
<tp:enumvalue suffix="RELATION_MEMBER_OF" value="5">
<tp:docstring>
- Object has a grouping relationship (e.g. ¨same group as¨) to one or more other objects.
+ Object has a grouping relationship (e.g. 'same group as') to one or more other objects.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="RELATION_TOOLTIP_FOR" value="6">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Object renders content which flows logically to another object.
For instance, text in a paragraph may flow to another object which is not the
- ¨next sibling¨ in the accessibility hierarchy. </p>
+ 'next sibling' in the accessibility hierarchy. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="RELATION_FLOWS_FROM" value="10">
<p>Denotes that the object is a transient window or frame associated with another onscreen object.
Similar to TOOLTIP_FOR, but more general. Useful for windows which are technically
toplevels but which, for one or more reasons, do not explicitly cause their associated
- window to lose ¨window focus¨. Creation of a ROLE_WINDOW object with the POPUP_FOR relation
+ window to lose 'window focus'. Creation of a ROLE_WINDOW object with the POPUP_FOR relation
usually requires some presentation action on the part of assistive technology clients, even though
the previous toplevel ROLE_FRAME object may still be the active window. </p>
</tp:docstring>
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
-
-
-
-
-
<tp:enum name="Role" type="u">
<tp:enumvalue suffix="ROLE_INVALID">
<tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_FOCUS_TRAVERSABLE" value="21">
<tp:docstring>
- XXX Don't use, reserved for future use.
+ Don't use, reserved for future use.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_FONT_CHOOSER" value="22">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An object which labels a particular row in a Table. Table rows and columns may also be
labelled via the RELATION_LABEL_FOR/RELATION_LABELLED_BY relationships;
- \see Accessibility::RelationSet. </p>
+ see Accessibility.RelationSet. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_TEAROFF_MENU_ITEM" value="59">
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_PARAGRAPH" value="73">
<tp:docstring>
- An object which is contains a single paragraph of text content. \see also ROLE_TEXT.
+ An object which is contains a single paragraph of text content. See also ROLE_TEXT.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_RULER" value="74">
<tp:enumvalue suffix="ROLE_ENTRY" value="79">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The object is a component whose textual content may be entered or modified by the user,
- provided STATE_EDITABLE is present.
- @note a readonly ROLE_ENTRY object (i.e. where STATE_EDITABLE is not present) implies a
- read-only ¨text field¨ in a form, as opposed to a title, label, or caption. </p>
-
- <p>@since AT-SPI 1.7.0</p>
+ provided STATE_EDITABLE is present. </p>
+ <p>A readonly ROLE_ENTRY object (i.e. where STATE_EDITABLE is not present) implies a
+ read-only 'text field' in a form, as opposed to a title, label, or caption. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_CHART" value="80">
quantitative data and information about how the data is being presented.
The LABELLED_BY relation is particularly important in interpreting objects of this type,
as is the accessible-description property.
- @see ROLE_CAPTION </p>
-
- <p>@since AT-SPI 1.7.0</p>
+ See ROLE_CAPTION </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_CAPTION" value="81">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The object contains descriptive information, usually textual, about another user interface
element such as a table, chart, or image. </p>
-
- <p>@since AT-SPI 1.7.0</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_DOCUMENT_FRAME" value="82">
document may be said to be embedded in the containing instance. HTML frames are
often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement
the Document interface. </p>
-
- <p>@since AT-SPI 1.7.0</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_HEADING" value="83">
<p>The object serves as a heading for content which follows it in a document.
The 'heading level' of the heading, if availabe, may be obtained by
querying the object's attributes. </p>
-
- <p>@since AT-SPI 1.7.0</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_PAGE" value="84">
<p>The object is a containing instance which encapsulates a page of
information. ROLE_PAGE is used in documents and content which support
a paginated navigation model. </p>
-
- <p>@since AT-SPI 1.7.0</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_SECTION" value="85">
a particular 'logical' section of the document. The type of content within
a section, and the nature of the section division itself, may be obtained
by querying the object's attributes. Sections may be nested. </p>
-
- <p>@since AT-SPI 1.7.0</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_REDUNDANT_OBJECT" value="86">
<p>The object is redundant with another object in the hierarchy,
and is exposed for purely technical reasons. Objects of this role
should be ignored by clients, if they are encountered at all. </p>
-
- <p>@since AT-SPI 1.7.6</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_FORM" value="87">
application instances, ROLE_FORM containers' components are associated with
the current document, rather than the current foreground application or
viewer instance. </p>
-
- <p>@since AT-SPI 1.7.6</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_LINK" value="88">
content which may also use the Hypertext/Hyperlink interfaces
to indicate the range/location within a text object where
an inline or embedded object lies. </p>
-
- <p>@since AT-SPI 1.7.6</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_INPUT_METHOD_WINDOW" value="89">
<p>The object is a window or similar viewport which is used
to allow composition or input of a 'complex character',
in other words it is an "input method window." </p>
-
- <p>@since AT-SPI 1.7.6</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_LAST_DEFINED" value="90">
<tp:docstring>
- not a valid role, used for finding end of enumeration.
+ Not a valid role, used for finding end of enumeration.
</tp:docstring>
</tp:enumvalue>
</tp:enum>
<?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>
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
-
-
-
-
-
<tp:struct name="Command">
<tp:docstring>
A structure which encapsulates both a string representation of a command and a unique command ID
<method name="notifyCommands">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Notify the CommandListener instance of changes to the currently
- available commands, by sending the current ::CommandList. </p>
-
- <p>@param commands The newly-available list of ::Command objects which
- may be invoked by the listener.</p>
+ available commands, by sending the current CommandList. </p>
</tp:docstring>
- <arg direction="in" name="commands" type="a(si)" tp:type="CommandList"/>
+ <arg direction="in" name="commands" type="a(si)" tp:type="CommandList">
+ <tp:docstring>
+ <p>The newly-available list of Command objects which
+ may be invoked by the listener.</p>
+ </tp:docstring>
+ </arg>
</method>
<interface name="org.freedesktop.atspi.Selector">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Examples of the use of this interface include voice-command and remote-control
applications, in which the user interaction is wholly or partly delegated by the
- implementor to an external agent.
- @since AT-SPI 1.7.0</p>
+ implementor to an external agent.</p>
</tp:docstring>
<tp:enum name="CommandResult" type="u">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>A code returned by a call to ::activateCommand, indicating
+ <p>A code returned by a call to activateCommand, indicating
the result of the activation request.</p>
</tp:docstring>
<tp:enumvalue suffix="COMMAND_RESULT_INVALID">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< The command was invalid or ill-formed; usually indicates
+ <p>The command was invalid or ill-formed; usually indicates
an error condition. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="COMMAND_RESULT_SUCCESS" value="1">
<tp:docstring>
- < The command was successfully activated.
+ The command was successfully activated.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="COMMAND_RESULT_FAILED" value="2">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< The command was valid, but could not be activated.
+ <p>The command was valid, but could not be activated.
This may be due to problems with permissions or error conditions.</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="COMMAND_RESULT_OBSOLETE" value="3">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< The command is no longer valid in the current program context.
+ <p>The command is no longer valid in the current program context.
This may mean that the application has changed state in such a
way that the specified command it no longer applicable, or
because changes to the application state have rendered it
</tp:enumvalue>
<tp:enumvalue suffix="COMMAND_RESULT_LAST_DEFINED" value="4">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Defines size of enumeration;
+ <p>Defines size of enumeration;
do not use this value as a parameter.</p>
</tp:docstring>
</tp:enumvalue>
</tp:enum>
<tp:property name="supportsReplace" type="b" access="read">
<tp:docstring>
- This attribute is TRUE if this Selector allows its ::CommandList to be specified by the client
+ This attribute is <code>True</code> if this Selector allows its CommandList to be specified by the client
</tp:docstring>
</tp:property>
<method name="getCommands">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Query the ::Selector for the current ::CommandList. </p>
+ <p>Query the Selector for the current CommandList.</p>
</tp:docstring>
<arg direction="out" type="a(si)" tp:type="CommandList">
<tp:docstring>
- the currently available ::CommandList
+ The currently available CommandList
</tp:docstring>
</arg>
</method>
<arg direction="in" name="commands" type="a(si)" tp:type="CommandList"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- TRUE if the replacement request was successful, FALSE if the request could not be honored.
+ <code>True</code> if the replacement request was successful, <code>True</code> if the
+ request could not be honored.
</tp:docstring>
</arg>
</method>
<method name="refreshCommands">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Ask the ::Selector to re-calculate its ::CommandList.
- @note in most cases the ::Selector will continuously
- update its ::CommandList without recourse to this call.
- This call is equivalent to ::getCommands, except that
- after ::refreshCommands the new ::CommandList will be returned
- via any registered ::CommandListener instances rather than
- synchronously via this call. </p>
+ <p>Ask the Selector to re-calculate its CommandList.</p>
+ <p>In most cases the Selector will continuously
+ update its CommandList without recourse to this call.
+ This call is equivalent to getCommands, except that
+ after refreshCommands the new CommandList will be returned
+ via any registered CommandListener instances rather than
+ synchronously via this call.</p>
</tp:docstring>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- TRUE if the ::CommandList changed.
+ <code>True</code> if the CommandList changed.
</tp:docstring>
</arg>
</method>
<method name="activateCommand">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Request that the ::Selector invoke the specified ::Command.
- @param cmd the ::Command to activate/invoke.</p>
+ <p>Request that the Selector invoke the specified Command.</p>
</tp:docstring>
- <arg direction="in" name="cmd" type="(si)" tp:type="Command"/>
+ <arg direction="in" name="cmd" type="(si)" tp:type="Command">
+ <tp:docstring>
+ <p>The Command to activate/invoke.</p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="u" tp:type="CommandResult">
<tp:docstring>
- a ::CommandResult indicating whether the request was honored, and the reason for failure if the::Command could not be activated or invoked.
+ A CommandResult indicating whether the request was honored, and the reason for failure if the Command could not be activated or invoked.
</tp:docstring>
</arg>
</method>
<method name="registerChangeListener">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Register a :CommandListener instance for notification of
- changes to the command set.
- @param listener the ::CommandListener to be notified of changes.</p>
+ changes to the command set.</p>
</tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="CommandListener"/>
+ <arg direction="in" name="listener" type="o" tp:type="CommandListener">
+ <tp:docstring>
+ <p>The CommandListener to be notified of changes.</p>
+ </tp:docstring>
+ </arg>
</method>
<method name="deregisterChangeListener">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Tell the ::Selector instance to cease notifying the
- specified ::CommandListener of changes to the command list.
- @param listener the ::CommandListener to remove from the
- notification list.</p>
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="CommandListener"/>
- </method>
- <method name="unImplemented">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>\cond
- unImplemented: </p>
-
- <p>placeholders for future expansion.</p>
+ <p>Tell the Selector instance to cease notifying the
+ specified CommandListener of changes to the command list.</p>
</tp:docstring>
- </method>
- <method name="unImplemented2">
- </method>
- <method name="unImplemented3">
- </method>
- <method name="unImplemented4">
+ <arg direction="in" name="listener" type="o" tp:type="CommandListener">
+ <tp:docstring>
+ <p>The CommandListener to remove from the
+ notification list.</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">
-
-
-
-
-
<tp:enum name="StateType" type="u">
<tp:enumvalue suffix="STATE_INVALID"/>
<tp:enumvalue suffix="STATE_ACTIVE" value="1">
</tp:enumvalue>
<tp:enumvalue suffix="STATE_VISIBLE" value="30">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.
- @note: STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only
+ <p>Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.</p>
+ <p>STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only
that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the
field of view, or having an ancestor container that has not yet made visible.
A widget is potentially onscreen if it has both STATE_VISIBLE and STATE_SHOWING.
</tp:enumvalue>
<tp:enumvalue suffix="STATE_TRUNCATED" value="34">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell.
- @since AT-SPI 1.7.0.</p>
+ <p>Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell.</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="STATE_ANIMATED" value="35">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Indicates this object's visual representation is dynamic, not static.
This state may be applied to an object during an animated 'effect' and
- be removed from the object once its visual representation becomes static.
- @note some applications, notably content viewers, may not be able to detect
+ be removed from the object once its visual representation becomes static.</p>
+ <p>some applications, notably content viewers, may not be able to detect
all kinds of animated content. Therefore the absence of this state should not
be taken as definitive evidence that the object's visual representation is
- static; this state is advisory. </p>
-
- <p>@since AT-SPI 1.7.0</p>
+ static; this state is advisory.</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="STATE_INVALID_ENTRY" value="36">
<p>This object has indicated an error condition due to failure of input
validation. For instance, a form control may acquire this state in response
to invalid or malformed user input. </p>
-
- <p>@since AT-SPI 1.7.0 </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="STATE_SUPPORTS_AUTOCOMPLETION" value="37">
In some cases the typeahead behavior may result in full or partial ¨completion¨ of
the data in the input field, in which case these input events may trigger text-changed
events from the source. </p>
-
- <p>@since AT-SPI 1.7.0 </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="STATE_SELECTABLE_TEXT" value="38">
the object in question is a selectable child of an object which implements
Selection. While similar, text selection and subelement selection are
distinct operations. </p>
-
- <p>@since AT-SPI 1.7.0 </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="STATE_IS_DEFAULT" value="39">
<p>This state indicates that the object in question is the 'default' interaction object
in a dialog, i.e. the one that gets activated if the user presses "Enter" when the
dialog is initially posted. </p>
-
- <p>@since AT-SPI 1.7.0 </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="STATE_VISITED" value="40">
<p>This state indicates that the object (typically a hyperlink)
has already been activated or invoked, with the result that some backing data
has been downloaded or rendered. </p>
-
- <p>@since AT-SPI 1.7.1 </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="STATE_LAST_DEFINED" value="41">
</tp:docstring>
<method name="contains">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Query a StateSet for a specific StateType.
- @param state the StateType being queried for.</p>
+ <p>Query a StateSet for a specific StateType.</p>
</tp:docstring>
- <arg direction="in" name="state" type="u" tp:type="StateType"/>
+ <arg direction="in" name="state" type="u" tp:type="StateType">
+ <tp:docstring>
+ <p>The StateType being queried for.</p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c TRUE if the StateSet contains StateType \a state.
+ <Code>True</Code> if the StateSet contains StateType state.
</tp:docstring>
</arg>
</method>
</method>
<method name="equals">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Compare two statesets for equivalence.
- @param tarStateSet the StateSet to be compared with this one.</p>
+ <p>Compare two statesets for equivalence.</p>
</tp:docstring>
- <arg direction="in" name="tarStateSet" type="o" tp:type="StateSet"/>
+ <arg direction="in" name="tarStateSet" type="o" tp:type="StateSet">
+ <tp:docstring>
+ <p>The StateSet to be compared with this one.</p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c TRUE if the two StateSet objects are composed of the same StateTypes.
+ <code>True</code> if the two StateSet objects are composed of the same StateTypes.
</tp:docstring>
</arg>
</method>
<arg direction="in" name="compareState" type="o" tp:type="StateSet"/>
<arg direction="out" type="o" tp:type="StateSet">
<tp:docstring>
- a 'difference set', i.e. a StateSet consisting of those states not shared by the two sets being compared.
+ A 'difference set', i.e. a StateSet consisting of those states not shared by the two sets being compared.
</tp:docstring>
</arg>
</method>
<method name="isEmpty">
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c TRUE if the StateSet contains no states.
+ <code>True</code> if the StateSet contains no states.
</tp:docstring>
</arg>
</method>
<method name="getStates">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>\cond
- Private </p>
- </tp:docstring>
<arg direction="out" type="au" tp:type="StateSeq"/>
</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>
- <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.ContentStream">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface by which the requested data from a StreamableContent object
- may be read by the client.
- @note this interface supercedes the use of BonoboStream by previous
- versions of StreamableContent. </p>
-
- <p>@since AT-SPI 1.7.0 </p>
+ may be read by the client.</p>
</tp:docstring>
</interface>
<tp:enum name="SeekType" type="u">
</tp:docstring>
<tp:enumvalue suffix="SEEK_SET">
<tp:docstring>
- < Seek from the start of the stream or data source.
+ Seek from the start of the stream or data source.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="SEEK_CURRENT" value="1">
<tp:docstring>
- < Seek relative to the current position.
+ Seek relative to the current position.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="SEEK_END" value="2">
<tp:docstring>
- < Seek from the end of the file, stream, or data source.
+ Seek from the end of the file, stream, or data source.
</tp:docstring>
</tp:enumvalue>
</tp:enum>
</tp:errors>
<method name="seek">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Seek to a specified position in the Stream.
- @param offset an offset specifying the requested position in the stream,
- relative to the SeekType specified in \c whence.
- @param whence a SeekType specifying the reference point from which the
- seek offset is calculated. Some forms of seek are not supported by certain
- implementations of Stream, in which case a NotSupported exception will be raised.</p>
+ <p>Seek to a specified position in the Stream.</p>
</tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="in" name="whence" type="u" tp:type="SeekType"/>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ An offset specifying the requested position in the stream,
+ relative to the SeekType specified in <code>whence.</code>
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="whence" type="u" tp:type="SeekType">
+ <tp:docstring>
+ A SeekType specifying the reference point from which the
+ seek offset is calculated. Some forms of seek are not supported by certain
+ implementations of Stream, in which case a NotSupported exception will be raised.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="i">
<tp:docstring>
- the actual resulting offset, if no exception was raised.
+ The actual resulting offset, if no exception was raised.
</tp:docstring>
</arg>
<tp:possible-errors>
<arg direction="out" name="buffer" type="ay" tp:type="iobuf"/>
<arg direction="out" type="i">
<tp:docstring>
- the number of bytes actually read into the client buffer.
+ The number of bytes actually read into the client buffer.
</tp:docstring>
</arg>
<tp:possible-errors>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>close the stream and release associated resources.
A client should not perform further operations on a
- StreamableContent::Stream object after closing it.</p>
- </tp:docstring>
-</method>
-<method name="unimplemented">
- <tp:docstring>
- /cond
+ StreamableContent.Stream object after closing it.</p>
</tp:docstring>
</method>
-<method name="unimplemented2">
-</method>
<interface name="org.freedesktop.atspi.StreamableContent">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface whereby an object allows its backing content
transform, convert, or parse the content in order to
present it in an alternate form to end-users. </p>
- <p>@note The StreamableContent interface is particularly useful for saving,
+ <p>The StreamableContent interface is particularly useful for saving,
printing, or post-processing entire documents, or for persisting
alternate views of a document.
If document content itself is being serialized, stored, or converted,
then use of the StreamableContent interface can help address performance
- issues. Unlike most AT-SPI/Accessibility interfaces, this interface
+ issues. Unlike most AT-SPI/Accessibility interfaces, this interface
is not strongly tied to the current user-agent view of the
a particular document, but may in some cases give access to the
underlying model data.</p>
</tp:docstring>
<method name="getContentTypes">
- <tp:docstring>
- getContentTypes:
- </tp:docstring>
<arg direction="out" type="as" tp:type="StringSeq">
<tp:docstring>
- the list of available mimetypes for this object's content.
+ The list of available mimetypes for this object's content.
</tp:docstring>
</arg>
</method>
<method name="getContent">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>\n DEPRECATED, use getStream instead.
+ <p>DEPRECATED, use getStream instead.
getContent:
Retrieve this object's content, in a format appropriate to a
requested mimetype. </p>
-
- <p>@note the data is returned as an object of type ::Bonobo::Stream.
- The primary methods which are supported on Bonobo::Streams for the
- purposes of the ::StreamableContent API are \c seek and \c read.
- \c seek may not be supported for all mimetypes or
- all implementors. </p>
-
- <p>\verbatim
- long Bonobo::Stream:seek (in long offset, in SeekType whence)
- raises (NoPermission, IOError)
- void Bonobo::Stream:read (in long count, out iobuf buffer)
- raises (NoPermission, IOError)
- \endverbatim </p>
-
- <p>@see ::Bonobo::Stream </p>
- </tp:docstring>
- <arg direction="in" name="contentType" type="s"/>
- <arg direction="out" type="FIXME" tp:type="Bonobo::Stream">
- <tp:docstring>
- a ::Bonobo::Stream whose mimetype matches \a contentType,if available, or \c NIL.
</tp:docstring>
+ <arg direction="in" name="contentType" type="s">
</arg>
</method>
<method name="getStream">
<p>Retrieve this object's content, in a format appropriate to a
requested mimetype, as a ::ContentStream instance. </p>
- <p>@note This method supercedes the older getContent method, which
- relied on the Bonobo::Stream API.
- \c seek may not be supported for all mimetypes or
- all implementors. </p>
-
- <p>@param contentType a string specifying the desired mimetype for the content stream.</p>
</tp:docstring>
- <arg direction="in" name="contentType" type="s"/>
+ <arg direction="in" name="contentType" type="s">
+ <tp:docstring>
+ <p>A string specifying the desired mimetype for the content stream.</p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="FIXME" tp:type="ContentStream">
<tp:docstring>
- a Stream whose mimetype matches \a contentType,if available, or \c NIL.@since AT-SPI 1.8.0
+ A Stream whose mimetype matches contentType,if available, or NIL.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get a URI pointing to the content of the specified type, if such a URI
can be obtained. Not all streamable content providers have URI representations. </p>
-
- <p>@param contentType a string specifying the desired mimetype for the content stream.
- If NULL, then a URI for the default content type will be returned, if available. </p>
</tp:docstring>
- <arg direction="in" name="contentType" type="s"/>
+ <arg direction="in" name="contentType" type="s">
+ <tp:docstring>
+ <p>A string specifying the desired mimetype for the content stream.
+ If NULL, then a URI for the default content type will be returned, if available. </p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="s">
<tp:docstring>
- a string which constitutes a URI for a stream of the specifiedcontent type, or NULL if no such URI can be obtained.
+ A string which constitutes a URI for a stream of the specifiedcontent type, or NULL if no such URI can be obtained.
</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>
</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.Table">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface used by containers whose contained data is arranged in
- a "tabular" (i.e.\ row-column) fashion. Tables may resemble a two-dimensional
+ a "tabular" (i.e. row/column) fashion. Tables may resemble a two-dimensional
grid, as in a spreadsheet, or may feature objects which span multiple rows and/or
columns, but whose bounds are aligned on a row/column matrix. Thus, the Table
interface may be used to represent "spreadsheets" as well as "frames". </p>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The number of rows currently selected.
A selected row is one in which all included cells are selected.
- @note Not all tables support row selection.</p>
+ Not all tables support row selection.</p>
</tp:docstring>
</tp:property>
<tp:property name="nSelectedColumns" type="i" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The number of columns currently selected.
A selected column is one in which all included cells are selected.
- @note Not all tables support column selection.</p>
+ Not all tables support column selection.</p>
</tp:docstring>
</tp:property>
<method name="getAccessibleAt">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get the table cell at the specified row and column indices.
- @note To get the accessible object at a particular (x, y) screen coordinate,
- use Accessible::getAccessibleAtPoint (). </p>
+ To get the accessible object at a particular (x, y) screen coordinate,
+ use Accessible.getAccessibleAtPoint ().</p>
</tp:docstring>
<arg direction="in" name="row" type="i">
<tp:docstring>
- the specified table row, zero-indexed.
+ The specified table row, zero-indexed.
</tp:docstring>
</arg>
<arg direction="in" name="column" type="i">
<tp:docstring>
- the specified table column, zero-indexed.
+ The specified table column, zero-indexed.
</tp:docstring>
</arg>
<arg direction="out" type="o" tp:type="Accessible">
<tp:docstring>
- an Accessible object representing the specified table cell.
+ An Accessible object representing the specified table cell.
</tp:docstring>
</arg>
</method>
<method name="getIndexAt">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get the 1-D child index corresponding to the specified 2-D row and column indices.
- @note To get the accessible object at a particular (x, y) screen coordinate,
- use Accessible::getAccessibleAtPoint. </p>
+ To get the accessible object at a particular (x, y) screen coordinate,
+ use Accessible.getAccessibleAtPoint. </p>
</tp:docstring>
<arg direction="in" name="row" type="i">
<tp:docstring>
- the specified table row, zero-indexed.
+ The specified table row, zero-indexed.
</tp:docstring>
</arg>
<arg direction="in" name="column" type="i">
<tp:docstring>
- the specified table column, zero-indexed.@see getRowAtIndex, getColumnAtIndex
+ The specified table column, zero-indexed.
</tp:docstring>
</arg>
<arg direction="out" type="i">
<tp:docstring>
- a long integer which serves as the index of a specified cell in thetable, in a form usable by Accessible::getChildAtIndex.
+ A long integer which serves as the index of a specified cell in the table,
+ in a form usable by Accessible.getChildAtIndex.
</tp:docstring>
</arg>
</method>
<method name="getRowAtIndex">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Get the table row index occupied by the child at a particular 1-D child index. </p>
+ <p>Get the table row index occupied by the child at a particular 1-D child index.</p>
</tp:docstring>
<arg direction="in" name="index" type="i">
<tp:docstring>
- the specified child index, zero-indexed.@see getIndexAt(), getColumnAtIndex()
+ The specified child index, zero-indexed.
</tp:docstring>
</arg>
<arg direction="out" type="i">
<tp:docstring>
- a long integer indicating the first row spanned by the child of atable, at the specified 1-D (zero-offset) \c index.
+ A long integer indicating the first row spanned by the child of atable, at the specified 1-D (zero-offset) index.
</tp:docstring>
</arg>
</method>
<method name="getColumnAtIndex">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Get the table column index occupied by the child at a particular 1-D child index. </p>
+ <p>Get the table column index occupied by the child at a particular 1-D child index.</p>
</tp:docstring>
<arg direction="in" name="index" type="i">
<tp:docstring>
- the specified child index, zero-indexed.@see getIndexAt(), getRowAtIndex()
+ The specified child index, zero-indexed.
</tp:docstring>
</arg>
<arg direction="out" type="i">
<tp:docstring>
- a long integer indicating the first column spanned by the child of atable, at the specified 1-D (zero-offset) \c index.
+ A long integer indicating the first column spanned by the child of a table,
+ at the specified 1-D (zero-offset) index.
</tp:docstring>
</arg>
</method>
<method name="getRowDescription">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Get a text description of a particular table row. This differs from
- AccessibleTable_getRowHeader, which returns an Accessible.</p>
+ <p>Get a text description of a particular table row. This differs from
+ AccessibleTable.getRowHeader, which returns an Accessible.</p>
</tp:docstring>
<arg direction="in" name="row" type="i">
<tp:docstring>
- the specified table row, zero-indexed.
+ The specified table row, zero-indexed.
</tp:docstring>
</arg>
<arg direction="out" type="s">
<tp:docstring>
- a UTF-8 string describing the specified table row, if available.
+ A UTF-8 string describing the specified table row, if available.
</tp:docstring>
</arg>
</method>
<method name="getColumnDescription">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Get a text description of a particular table column. This differs from
- AccessibleTable_getColumnHeader, which returns an Accessible.</p>
+ <p>Get a text description of a particular table column. This differs from
+ AccessibleTable.getColumnHeader, which returns an Accessible.</p>
</tp:docstring>
<arg direction="in" name="column" type="i">
<tp:docstring>
- the specified table column, zero-indexed.
+ The specified table column, zero-indexed.
</tp:docstring>
</arg>
<arg direction="out" type="s">
<tp:docstring>
- a UTF-8 string describing the specified table column, if available.
+ A UTF-8 string describing the specified table column, if available.
</tp:docstring>
</arg>
</method>
<method name="getRowExtentAt">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get the number of rows spanned by the table cell at the specific row and column.
- (some tables can have cells which span multiple rows and/or columns). </p>
+ (some tables can have cells which span multiple rows and/or columns).</p>
</tp:docstring>
<arg direction="in" name="row" type="i">
<tp:docstring>
- the specified table row, zero-indexed.
+ The specified table row, zero-indexed.
</tp:docstring>
</arg>
<arg direction="in" name="column" type="i">
<tp:docstring>
- the specified table column, zero-indexed.
+ The specified table column, zero-indexed.
</tp:docstring>
</arg>
<arg direction="out" type="i">
<tp:docstring>
- a long integer indicating the number of rows spanned by the specified cell.
+ A long integer indicating the number of rows spanned by the specified cell.
</tp:docstring>
</arg>
</method>
<method name="getColumnExtentAt">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get the number of columns spanned by the table cell at the specific row and column.
- (some tables can have cells which span multiple rows and/or columns). </p>
+ (some tables can have cells which span multiple rows and/or columns).</p>
</tp:docstring>
<arg direction="in" name="row" type="i">
<tp:docstring>
- the specified table row, zero-indexed.
+ The specified table row, zero-indexed.
</tp:docstring>
</arg>
<arg direction="in" name="column" type="i">
<tp:docstring>
- the specified table column, zero-indexed.
+ The specified table column, zero-indexed.
</tp:docstring>
</arg>
<arg direction="out" type="i">
<tp:docstring>
- a long integer indicating the number of columns spanned by the specified cell.
+ A long integer indicating the number of columns spanned by the specified cell.
</tp:docstring>
</arg>
</method>
<method name="getRowHeader">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get the header associated with a table row, if available. This differs from
- getRowDescription, which returns a string. </p>
+ getRowDescription, which returns a string.</p>
</tp:docstring>
<arg direction="in" name="row" type="i">
<tp:docstring>
- the specified table row, zero-indexed.
+ The specified table row, zero-indexed.
</tp:docstring>
</arg>
<arg direction="out" type="o" tp:type="Accessible">
<tp:docstring>
- an Accessible representatin of the specified table row, if available.
+ An Accessible representatin of the specified table row, if available.
</tp:docstring>
</arg>
</method>
<method name="getColumnHeader">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get the header associated with a table column, if available, as an
- instance of Accessible. This differs from
- getColumnDescription, which returns a string. </p>
+ instance of Accessible. This differs from
+ getColumnDescription, which returns a string.</p>
</tp:docstring>
<arg direction="in" name="column" type="i">
<tp:docstring>
- the specified table column, zero-indexed.
+ The specified table column, zero-indexed.
</tp:docstring>
</arg>
<arg direction="out" type="o" tp:type="Accessible">
<tp:docstring>
- an Accessible representatin of the specified table column, if available.
+ An Accessible representatin of the specified table column, if available.
</tp:docstring>
</arg>
</method>
<method name="getSelectedRows">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain the indices of all rows which are currently selected.
- @note Not all tables support row selection. </p>
+ Not all tables support row selection. </p>
</tp:docstring>
<arg direction="out" type="ai" tp:type="LongSeq">
<tp:docstring>
- a sequence of integers comprising the indices of rows currently selected.
+ A sequence of integers comprising the indices of rows currently selected.
</tp:docstring>
</arg>
</method>
<method name="getSelectedColumns">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain the indices of all columns which are currently selected.
- @note Not all tables support column selection. </p>
+ Not all tables support column selection. </p>
</tp:docstring>
<arg direction="out" type="ai" tp:type="LongSeq">
<tp:docstring>
- a sequence of integers comprising the indices of columns currently selected.
+ A sequence of integers comprising the indices of columns currently selected.
</tp:docstring>
</arg>
</method>
<method name="isRowSelected">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Determine whether a table row is selected.
- @note Not all tables support row selection. </p>
+ Not all tables support row selection. </p>
</tp:docstring>
<arg direction="in" name="row" type="i">
<tp:docstring>
- the row being queried.
+ The row being queried.
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the specified row is currently selected, \c False if not.
+ <code>True</code> if the specified row is currently selected, <code>False</code> if not.
</tp:docstring>
</arg>
</method>
<method name="isColumnSelected">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Determine whether a table column is selected.
- @note Not all tables support column selection. </p>
+ Not all tables support column selection. </p>
</tp:docstring>
<arg direction="in" name="column" type="i">
<tp:docstring>
- the column being queried.
+ The column being queried.
</tp:docstring>
</arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the specified column is currently selected, \c False if not.
+ <code>True</code> if the specified column is currently selected, <code>False</code> if not.
</tp:docstring>
</arg>
</method>
<method name="isSelected">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Determine whether the cell at a specific row and column is selected.
- @param row a row occupied by the cell whose state is being queried.
- @param column a column occupied by the cell whose state is being queried. </p>
+ <p>Determine whether the cell at a specific row and column is selected.</p>
</tp:docstring>
- <arg direction="in" name="row" type="i"/>
- <arg direction="in" name="column" type="i"/>
+ <arg direction="in" name="row" type="i">
+ <tp:docstring>
+ A row occupied by the cell whose state is being queried.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="column" type="i">
+ <tp:docstring>
+ A column occupied by the cell whose state is being queried.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the specified cell is currently selected, \c False if not.
+ <code>True</code> if the specified cell is currently selected, <code>False</code> if not.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Select the specified row, adding it to the current row selection,
if the table's selection model permits it. </p>
-
- <p>@param row
- @note Possible reasons for addRowSelection to return \c False
+ </tp:docstring>
+ <arg direction="in" name="row" type="i">
+ <tp:docstring>
+ <p>
+ Possible reasons for addRowSelection to return <code>False</code>
include:
- \li The table does not support Selection
- \li The table row includes cells which do not have STATE_SELECTABLE
- \li The table does not support selection by row
- \li The table does not support selection of multiple rows, and
- one row is already selected.
- \li The table does not support non-contiguous selections (i.e.
- does not include STATE_MULTISELECTABLE), and the specified row
- would result in selection of non-contiguous rows.
- \li The table does not support user-instigated selection. </p>
- </tp:docstring>
- <arg direction="in" name="row" type="i"/>
+ <ol>
+ <li>The table does not support Selection</li>
+ <li>The table row includes cells which do not have STATE_SELECTABLE</li>
+ <li>The table does not support selection by row</li>
+ <li>The table does not support selection of multiple rows, and one row is already selected.</li>
+ <li>The table does not support non-contiguous selections (i.e. does not include STATE_MULTISELECTABLE), and the specified row would result in selection of non-contiguous rows.</li>
+ <li>The table does not support user-instigated selection</li>
+ </ol>
+ </p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the specified row was successfully selected, \c False if not.
+ <code>True</code> if the specified row was successfully selected, <code>False</code> if not.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Select the specified column, adding it to the current column selection,
if the table's selection model permits it. </p>
-
- <p>@param column
- @note Possible reasons for addColumnSelection to return \c False
+ </tp:docstring>
+ <arg direction="in" name="column" type="i">
+ <tp:docstring>
+ <p>
+ Possible reasons for addColumnSelection to return <code>False</code>
include:
- \li The table does not support Selection
- \li The table column includes cells which do not have STATE_SELECTABLE
- \li The table does not support selection by column
- \li The table does not support selection of multiple columns, and
- one column is already selected.
- \li The table does not support non-contiguous selections (i.e.
- does not include STATE_MULTISELECTABLE), and the specified column
- would result in selection of non-contiguous columns.
- \li The table does not support user-instigated selection. </p>
- </tp:docstring>
- <arg direction="in" name="column" type="i"/>
+ <ol>
+ <li>The table does not support Selection</li>
+ <li>The table column includes cells which do not have STATE_SELECTABLE</li>
+ <li>The table does not support selection by column</li>
+ <li>The table does not support selection of multiple column, and one column is already selected.</li>
+ <li>The table does not support non-contiguous selections (i.e. does not include STATE_MULTISELECTABLE), and the specified column would result in selection of non-contiguous columns.</li>
+ <li>The table does not support user-instigated selection</li>
+ </ol>
+ </p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the specified column was successfully selected, \c False if not.
+ <code>True</code> if the specified column was successfully selected, <code>False</code> if not.
</tp:docstring>
</arg>
</method>
<p>Remove the specified row from current row selection,
if the table's selection model permits it. </p>
- <p>@param row
- @note Possible reasons for removeRowSelection to return \c False
- include:
- \li The table does not support user-instigated Selection
- \li The table has no selected rows or does not support deselection by row </p>
</tp:docstring>
- <arg direction="in" name="row" type="i"/>
+ <arg direction="in" name="row" type="i">
+ <tp:docstring>
+ <p>
+ Possible reasons for removeRowSelection to return <code>False</code>
+ include:
+ <ol>
+ <li>The table does not support user-instigated Selection</li>
+ <li>The table has no selected rows or does not support deselection by row </li>
+ </ol>
+ </p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the specified row was successfully de-selected, \c False if not.
+ <code>True</code> if the specified row was successfully de-selected, <code>False</code> if not.
</tp:docstring>
</arg>
</method>
<p>Remove the specified column from current column selection,
if the table's selection model permits it. </p>
- <p>@param column
- @note Possible reasons for removeColumnSelection to return \c False
- include:
- \li The table does not support user-instigated modification of
- selection state
- \li The table has no selected columns or does not support
- deselection by column. </p>
</tp:docstring>
- <arg direction="in" name="column" type="i"/>
+ <arg direction="in" name="column" type="i">
+ <tp:docstring>
+ <p>
+ Possible reasons for removeColumnSelection to return \c <code>False</code>
+ include:
+ <ol>
+ <li>The table does not support user-instigated modification of selection state</li>
+ <li>The table has no selected columns or does not support deselection by column.</li>
+ </ol>
+ </p>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the specified column was successfully de-selected, \c False if not.
+ <code>True</code> if the specified column was successfully de-selected, <code>False</code> if not.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Given a child index, determine the row and column indices and
extents, and whether the cell is currently selected. If
- the child at \c index is not a cell (for instance, if it is
- a summary, caption, etc.), \c False is returned. </p>
+ the child at index is not a cell (for instance, if it is
+ a summary, caption, etc.), <code>False</code> is returned. </p>
- <p>@param index the index of the Table child whose row/column
- extents are requested.
- @param row back-filled with the first table row associated with
- the cell with child index \c index.
- @param col back-filled with the first table column associated
- with the cell with child index \c index.
- @param row_extents back-filled with the number of table rows
- across which child \c i extends.
- @param col_extents back-filled with the number of table columns
- across which child \c i extends.
- @param is_selected a boolean which is back-filled with \c True
- if the child at index \c i corresponds to a selected table cell,
- \c False otherwise. </p>
<p>Example:
If the Table child at index '6' extends across columns 5 and 6 of
row 2 of a Table instance, and is currently selected, then
- \code
+ <code>
retval = table::getRowColumnExtentsAtIndex (6, row, col,
row_extents,
col_extents,
is_selected);
- \endcode
- will return True, and after the call
- \c row, \c col, \c row_extents, \c col_extents,
- and \c is_selected will contain \c 2, \c 5, \c 1, \c 2, and
- \c True, respectively. </p>
- </tp:docstring>
- <arg direction="in" name="index" type="i"/>
- <arg direction="out" name="row" type="i"/>
- <arg direction="out" name="col" type="i"/>
- <arg direction="out" name="row_extents" type="i"/>
- <arg direction="out" name="col_extents" type="i"/>
- <arg direction="out" name="is_selected" type="b" tp:type="boolean"/>
+ </code>
+ will return <code>True</code>, and after the call
+ <code> row, col, row_extents, col_extents, </code>
+ <code>is_selected </code> will contain <code>2, 5, 1, 2,</code> and
+ <code>True</code>, respectively.
+ </p>
+ </tp:docstring>
+ <arg direction="in" name="index" type="i">
+ <tp:docstring>
+ Ihe index of the Table child whose row/column
+ extents are requested.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="row" type="i">
+ <tp:docstring>
+ Back-filled with the first table row associated with
+ the cell with child index index.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="col" type="i">
+ <tp:docstring>
+ Back-filled with the first table column associated
+ with the cell with child index index.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="row_extents" type="i">
+ <tp:docstring>
+ Back-filled with the number of table rows
+ across which child i extends.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="col_extents" type="i">
+ <tp:docstring>
+ Back-filled with the number of table columns
+ across which child i extends.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="is_selected" type="b" tp:type="boolean">
+ <tp:docstring>
+ A boolean which is back-filled with <code>True</code>
+ if the child at index i corresponds to a selected table cell,
+ <code>False</code> otherwise.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the index is associated with a valid tablecell, \c False if the index does not correspond to a cell. If \c False is returned, the values of the out parameters are undefined.@since AT-SPI 1.7.0
+ <code>True</code> if the index is associated with a valid table-cell,
+ <code>False</code> if the index does not correspond to a cell.
+ If <code>False</code> is returned, the values of the out parameters are undefined.
</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>
- <method name="unImplemented5">
- </method>
- <method name="unImplemented6">
- </method>
- <method name="unImplemented7">
- </method>
</interface>
</node>
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
-
-
-
-
-
<tp:enum name="TEXT_BOUNDARY_TYPE" type="u">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Specifies the boundary conditions determining a run of text as returned from
</tp:docstring>
<tp:enumvalue suffix="TEXT_BOUNDARY_CHAR">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Text is bounded by this character only.
+ <p>Text is bounded by this character only.
Start and end offsets differ by one, by definition, for this value. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_WORD_START" value="1">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is start of a word; i.e. range is from start of
+ <p>Boundary condition is start of a word; i.e. range is from start of
one word to the start of another word. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_WORD_END" value="2">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is the end of a word; i.e. range is from
- the end of one word to the end of another.
- @note some locales may not distinguish between words and
+ <p>Boundary condition is the end of a word; i.e. range is from
+ the end of one word to the end of another.</p>
+ <p>Some locales may not distinguish between words and
characters or glyphs, in particular those locales which use
wholly or partially ideographic character sets. In these cases,
characters may be returned in lieu of multi-character substrings.</p>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_SENTENCE_START" value="3">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is start of a sentence, as determined
- by the application.
- @note Some locales or character sets may not include explicit sentence
+ <p>Boundary condition is start of a sentence, as determined
+ by the application.</p>
+ <p>Some locales or character sets may not include explicit sentence
delimiters, so this boundary type can not always be honored.
Some locales will return lines of text instead of grammatical sentences.</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_SENTENCE_END" value="4">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is end of a sentence, as determined by the application,
- including the sentence-delimiting character, for instance '.'
- @note Some locales or character sets may not include explicit sentence
+ <p>Boundary condition is end of a sentence, as determined by the application,
+ including the sentence-delimiting character, for instance '.'</p>
+ <p>Some locales or character sets may not include explicit sentence
delimiters, so this boundary type can not always be honored.
Some locales will return lines of text instead of grammatical sentences.</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_LINE_START" value="5">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is the start of a line; i.e. range is
+ <p> Boundary condition is the start of a line; i.e. range is
from start of one line to the start of another. This generally
means that an end-of-line character will appear at the end of the range. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_LINE_END" value="6">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is the end of a line; i.e. range is
+ <p> Boundary condition is the end of a line; i.e. range is
from start of one line to the start of another. This generally
means that an end-of-line character will be the first character of the range. </p>
</tp:docstring>
<tp:enumvalue suffix="TEXT_CLIP_NONE"/>
<tp:enumvalue suffix="TEXT_CLIP_MIN" value="1">
<tp:docstring>
- < characters/glyphs clipped by the minimum coordinate are omitted
+ Characters/glyphs clipped by the minimum coordinate are omitted
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_CLIP_MAX" value="2">
<tp:docstring>
- < characters/glyphs which intersect the maximum coordinate are omitted
+ Characters/glyphs which intersect the maximum coordinate are omitted
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_CLIP_BOTH" value="3">
<tp:docstring>
- < only glyphs falling entirely within the region bounded by min and max are retained.
+ Only glyphs falling entirely within the region bounded by min and max are retained.
</tp:docstring>
</tp:enumvalue>
</tp:enum>
<p>In some cases a Text object may have, as its content, an empty string. In particular this can
occur in the case of Hypertext objects which do not display explicitly textual information onscreen,
- as Hypertext is derived from the Text interface. @see Hypertext. </p>
+ as Hypertext is derived from the Text interface, see Hypertext. </p>
<p>Typographic and semantic attributes of onscreen textual content, for instance typeface, weight,
language, and such qualities as 'emphasis' or 'blockquote', are represented as text attributes.
Contiguous sequences of characters over which these attributes are unchanged are referred to as
- "attribute runs", and are available via Text::getAttributeRun. Where possible, implementing clients
+ 'attribute runs', and are available via Text.getAttributeRun. Where possible, implementing clients
will report textual attributes which are the same over the entire text object, for instance those
inherited from a default or document-scope style, via getDefaultAttributes instead of reporting them
explicitly for each character. Therefore, for any span of text, the attributes in effect are the union
- of the set returned by Text::getDefaultAttributes, and the set returned at a particular character
- offset via Text::getAttributeRun. </p>
+ of the set returned by Text.getDefaultAttributes, and the set returned at a particular character
+ offset via Text.getAttributeRun. </p>
- <p>@note Events that may be emitted by instances of Text include:
- \li \c "object:text-attributes-changed" The attributes of a range of text, or the range over
- which attributes apply, has changed.
- \li \c "object:text-changed" The text content of this object has changed.
- \li \c "object:text-bounds-changed" The character bounds of a text object have changed,
- for instance in response to a reformatting or reflow operation.
- \li \c "object:text-caret-moved" The character offset of the text caret (visible or notional) within
- this object has changed. Events of this type may also be generated when an onscreen
- text caret appears or disappears.
- \li \c "object:text-selection-changed" The range or number of text selections within this text object
- has changed. </p>
+ <p>Events that may be emitted by instances of Text include:
+ <ol>
+ <li>'object:text-attributes-changed' The attributes of a range of text, or the range
+ over which attributes apply, has changed.</li>
+ <li>'object:text-changed' The text content of this object has changed.</li>
+ <li>'object:text-bounds-changed' The character bounds of a text object have changed,
+ for instance in response to a reformatting or reflow operation.</li>
+ <li>'object:text-caret-moved' The character offset of the text caret
+ (visible or notional) within this object has changed. Events of this
+ type may also be generated when an onscreen text caret appears or disappears.</li>
+ <li>'object:text-selection-changed' The range or number of text selections within
+ this text object has changed.</li>
+ </ol>
+ </p>
- <p>@note In some cases, objects which are not onscreen may implement Text, but if such objects
+ <p>In some cases, objects which are not onscreen may implement Text, but if such objects
implement Component, their potential visibility should be examined (via comparison with STATE_VISIBLE
and STATE_SHOWING) before exposing them to the user. Objects which implement Text but not Component
- may be encountered in special-purpose interfaces or as special ¨accessibility¨ extensions to visual
+ may be encountered in special-purpose interfaces or as special 'accessibility' extensions to visual
interfaces to allow non-graphical access to application features. These instances should be considered
the exception, rather than the rule.</p>
</tp:docstring>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain all or part of the onscreen textual content of a Text object. If endOffset is specified as
"-1", then this method will return the entire onscreen textual contents of the Text object.
- @note 'onscreen' in this context means "potentially onscreen", this method does not perform any sort
+ onscreen' in this context means "potentially onscreen", this method does not perform any sort
of coordinate visibility clipping or window-stack-ordering clipping. The text thus reported
corresponds to the text which would be presented onscreen if the object implementing the Text interface
were entirely unobscured. </p>
<arg direction="in" name="endOffset" type="i"/>
<arg direction="out" type="s">
<tp:docstring>
- the textual content of the current Text object beginning startOffset (inclusive) up to but not including the character at endOffset.
+ The textual content of the current Text object beginning startOffset (inclusive) up to but not including the character at endOffset.
</tp:docstring>
</arg>
</method>
<method name="setCaretOffset">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Programmatically move the text caret (visible or virtual, as above) to a given position.
- @param offset a long int indicating the desired character offset. Not all implementations of
- Text will honor setCaretOffset requests, so the return value below should be checked by the client.</p>
+ <p>Programmatically move the text caret (visible or virtual, as above) to a given position.</p>
</tp:docstring>
- <arg direction="in" name="offset" type="i"/>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ A long int indicating the desired character offset. Not all implementations of
+ Text will honor setCaretOffset requests, so the return value below should be checked by the client.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c TRUE if the request was carried out, or \c FALSE if the caret could not be moved to the requested position.
+ <code>True</code> if the request was carried out, or <code>False</code> if the caret could not be moved to the requested position.
</tp:docstring>
</arg>
</method>
<method name="getTextBeforeOffset">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Obtain a subset of the text content of an object which entirely precedes \c offset,
- delimited by character, word, line, or sentence boundaries as specified by \c type. The
- starting and ending offsets of the resulting substring are returned in \c startOffset
- and \c endOffset. By definition, if such a substring exists, \c endOffset is less than or
- equal to \c offset.
- @param offset the offset from which the substring search begins.
- @param type the text-boundary delimiter which determines whether the returned text constitures
+ <p>Obtain a subset of the text content of an object which entirely precedes <code>offset</code>,
+ delimited by character, word, line, or sentence boundaries as specified by <code>type</code>. The
+ starting and ending offsets of the resulting substring are returned in <code>startOffset</code>
+ and <code>startOffset</code>. By definition, if such a substring exists, <code>startOffset</code>
+ is less than or equal to <code>offset.</code></p>
+ </tp:docstring>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The offset from which the substring search begins.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE">
+ <tp:docstring>
+ The text-boundary delimiter which determines whether the returned text constitures
a character, word, line, or sentence (and possibly attendant whitespace),
and whether the start or ending of such a substring forms the boundary condition.
- @param startOffset back-filled with the starting offset of the resulting substring, if one exists.
- @param endOffset back-filled with the offset of the character immediately following the resulting
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="startOffset" type="i">
+ <tp:docstring>
+ Back-filled with the starting offset of the resulting substring, if one exists.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="endOffset" type="i">
+ <tp:docstring>
+ Back-filled with the offset of the character immediately following the resulting
substring, if one exists.
- @see TEXT_BOUNDARY_TYPE</p>
- </tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE"/>
- <arg direction="out" name="startOffset" type="i"/>
- <arg direction="out" name="endOffset" type="i"/>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="s">
<tp:docstring>
- a string which is a substring of the text content of the object, delimited by thespecified boundary condition.
+ A string which is a substring of the text content of the object, delimited by thespecified boundary condition.
</tp:docstring>
</arg>
</method>
<method name="getTextAtOffset">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Obtain a subset of the text content of an object which includes the specified \c offset,
- delimited by character, word, line, or sentence boundaries as specified by \c type. The
- starting and ending offsets of the resulting substring are returned in \c startOffset
- and \c endOffset.
- @param offset the offset from which the substring search begins, and which must
+ <p>Obtain a subset of the text content of an object which includes the specified <code>offset</code>,
+ delimited by character, word, line, or sentence boundaries as specified by <code>type</code>. The
+ starting and ending offsets of the resulting substring are returned in <code>startOffset</code>
+ and <code>endOffset</code>.</p>
+ </tp:docstring>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The offset from which the substring search begins, and which must
lie within the returned substring.
- @param type the text-boundary delimiter which determines whether the returned text constitures
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE">
+ <tp:docstring>
+ The text-boundary delimiter which determines whether the returned text constitures
a character, word, line, or sentence (and possibly attendant whitespace),
and whether the start or ending of such a substring forms the boundary condition.
- @param startOffset back-filled with the starting offset of the resulting substring, if one exists.
- @param endOffset back-filled with the offset of the character immediately following the resulting
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="startOffset" type="i">
+ <tp:docstring>
+ Back-filled with the starting offset of the resulting substring, if one exists.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="endOffset" type="i">
+ <tp:docstring>
+ Back-filled with the offset of the character immediately following the resulting
substring, if one exists.
- @see TEXT_BOUNDARY_TYPE</p>
- </tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE"/>
- <arg direction="out" name="startOffset" type="i"/>
- <arg direction="out" name="endOffset" type="i"/>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="s">
<tp:docstring>
- a string which is a substring of the text content of the object, delimited by thespecified boundary condition.
+ A string which is a substring of the text content of the object, delimited by thespecified boundary condition.
</tp:docstring>
</arg>
</method>
<method name="getTextAfterOffset">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Obtain a subset of the text content of an object which entirely follows \c offset,
- delimited by character, word, line, or sentence boundaries as specified by \c type. The
- starting and ending offsets of the resulting substring are returned in \c startOffset
- and \c endOffset. By definition, if such a substring exists, \c startOffset must be greater than
- \c offset.
- @param offset the offset from which the substring search begins, and which must
+ <p>Obtain a subset of the text content of an object which entirely follows <code>offset</code>,
+ delimited by character, word, line, or sentence boundaries as specified by <code>type</code>. The
+ starting and ending offsets of the resulting substring are returned in <code>startOffset</code>
+ and <code>endOffset</code>. By definition, if such a substring exists, <code>startOffset</code>
+ must be greater than <code>offset</code>.</p>
+ </tp:docstring>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The offset from which the substring search begins, and which must
lie before the returned substring.
- @param type the text-boundary delimiter which determines whether the returned text constitures
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE">
+ <tp:docstring>
+ The text-boundary delimiter which determines whether the returned text constitures
a character, word, line, or sentence (and possibly attendant whitespace),
and whether the start or ending of such a substring forms the boundary condition.
- @param startOffset back-filled with the starting offset of the resulting substring, if one exists.
- @param endOffset back-filled with the offset of the character immediately following the resulting
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="startOffset" type="i">
+ <tp:docstring>
+ Back-filled with the starting offset of the resulting substring, if one exists.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="endOffset" type="i">
+ <tp:docstring>
+ Back-filled with the offset of the character immediately following the resulting
substring, if one exists.
- @see TEXT_BOUNDARY_TYPE</p>
- </tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE"/>
- <arg direction="out" name="startOffset" type="i"/>
- <arg direction="out" name="endOffset" type="i"/>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="s">
<tp:docstring>
- a string which is a substring of the text content of the object, delimited by thespecified boundary condition.
+ A string which is a substring of the text content of the object, delimited by thespecified boundary condition.
</tp:docstring>
</arg>
</method>
<arg name="offset" type="i" direction="in"/>
<arg type="i" direction="out">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- an unsigned long integer whose value corresponds to the UCS-4 representation of the
+ An unsigned long integer whose value corresponds to the UCS-4 representation of the
character at the specified text offset, or 0 if offset is out of range.
- long instead of wchar, to allow unicode chars > 16 bits
+ long instead of wchar, to allow unicode chars 16 bits
</tp:docstring>
</arg>
</method>
<method name="getAttributeValue">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Get the string value of a named attribute at a given offset, if defined.
- @param offset the offset of the character for which the attribute run is to be obtained.
- @param attributeName the name of the attribute for which the value is to be returned, if defined.
- @param startOffset back-filled with the offset of the first character in the attribute run
- containing the character at \c offset.
- @param endOffset back-filled with the offset of the first character past the end of the
- attribute run containing the character at \c offset.
- @param defined back-filled with \c True if the attributeName has a defined value at \c offset,
- \c False otherwise.</p>
+ <p>Get the string value of a named attribute at a given offset, if defined.</p>
</tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="in" name="attributeName" type="s"/>
- <arg direction="out" name="startOffset" type="i"/>
- <arg direction="out" name="endOffset" type="i"/>
- <arg direction="out" name="defined" type="b" tp:type="boolean"/>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The offset of the character for which the attribute run is to be obtained.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="attributeName" type="s">
+ <tp:docstring>
+ The name of the attribute for which the value is to be returned, if defined.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="startOffset" type="i">
+ <tp:docstring>
+ Back-filled with the offset of the first character in the attribute run
+ containing the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="endOffset" type="i">
+ <tp:docstring>
+ Back-filled with the offset of the first character past the end of the
+ attribute run containing the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="defined" type="b" tp:type="boolean">
+ <tp:docstring>
+ Back-filled with <code>True</code> if the attributeName has a defined value at <code>offset</code>,
+ <code>False</code> otherwise.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="s">
<tp:docstring>
- the value of attribute (name-value pair) corresponding to "name", if defined.
+ The value of attribute (name-value pair) corresponding to "name", if defined.
</tp:docstring>
</arg>
</method>
<arg direction="out" name="endOffset" type="i"/>
<arg direction="out" type="s">
<tp:docstring>
- the attributes at offset, as a semicolon-delimited set of colon-delimited name-value pairs. @see getAttributeRun
+ The attributes at offset, as a semicolon-delimited set of colon-delimited name-value pairs. @see getAttributeRun
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="out" type="s">
<tp:docstring>
- the attributes which apply to the entire text content, but which were not explicitlyspecified by the content creator.@see getDefaultAttributeSet
+ The attributes which apply to the entire text content, but which were not explicitlyspecified by the content creator.
</tp:docstring>
</arg>
</method>
character offset in this object's text content. The coordinate system in which the results are
reported is specified by coordType. If an onscreen glyph corresponds to multiple character offsets,
for instance if the glyph is a ligature, the bounding box reported will include the entire glyph and
- therefore may apply to more than one character offset.
- @param offset the character offset of the character or glyph being queried.
- @param x the minimum horizontal coordinate of the bounding box of the glyph representing
- the character at \c offset.
- @param y the minimum vertical coordinate of the bounding box of the glyph representing
- the character at \c offset.
- @param width the horizontal extent of the bounding box of the glyph representing
- the character at \c offset.
- @param height the vertical extent of the bounding box of the glyph representing
- the character at \c offset.
- @param coordType If 0, the results will be reported in screen coordinates, i.e. in pixels
+ therefore may apply to more than one character offset.</p>
+ </tp:docstring>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The character offset of the character or glyph being queried.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="x" type="i">
+ <tp:docstring>
+ The minimum horizontal coordinate of the bounding box of the glyph representing
+ the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="y" type="i">
+ <tp:docstring>
+ The minimum vertical coordinate of the bounding box of the glyph representing
+ the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="width" type="i">
+ <tp:docstring>
+ The horizontal extent of the bounding box of the glyph representing
+ the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="height" type="i">
+ <tp:docstring>
+ The vertical extent of the bounding box of the glyph representing
+ the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="coordType" type="n" tp:type="short">
+ <tp:docstring>
+ <p>If 0, the results will be reported in screen coordinates, i.e. in pixels
relative to the upper-left corner of the screen, with the x axis pointing right
and the y axis pointing down.
If 1, the results will be reported relative to the containing toplevel window,
with the x axis pointing right and the y axis pointing down.</p>
- </tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="out" name="x" type="i"/>
- <arg direction="out" name="y" type="i"/>
- <arg direction="out" name="width" type="i"/>
- <arg direction="out" name="height" type="i"/>
- <arg direction="in" name="coordType" type="n" tp:type="short"/>
+ </tp:docstring>
+ </arg>
</method>
<method name="getOffsetAtPoint">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get the offset of the character at a given onscreen coordinate. The coordinate system used to interpret
- x and y is determined by parameter coordType.
- @param x
- @param y
- @param coordType if 0, the input coordinates are interpreted relative to the entire screen, if 1,
- they are relative to the toplevel window containing this Text object.</p>
+ x and y is determined by parameter coordType.</p>
</tp:docstring>
<arg direction="in" name="x" type="i"/>
<arg direction="in" name="y" type="i"/>
- <arg direction="in" name="coordType" type="n" tp:type="short"/>
+ <arg direction="in" name="coordType" type="n" tp:type="short">
+ <tp:docstring>
+ If 0, the input coordinates are interpreted relative to the entire screen, if 1,
+ they are relative to the toplevel window containing this Text object.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="i">
<tp:docstring>
- the text offset (as an offset into the character array) of the glyph whose onscreen bounds contain the point x,y, or -1 if the point is outside the bounds of any glyph.
+ The text offset (as an offset into the character array) of the glyph whose onscreen bounds contain the point x,y, or -1 if the point is outside the bounds of any glyph.
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="out" type="i">
<tp:docstring>
- the number of contiguous selections in the current Text object.
+ The number of contiguous selections in the current Text object.
</tp:docstring>
</arg>
</method>
<arg direction="in" name="endOffset" type="i"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True of the selection was successfully added, \c False otherwise. Selection mayfail if the object does not support selection of text (see STATE_SELECTABLE_TEXT), if theobject does not support multiple selections and a selection is already defined, or for other reasons(for instance if the user does not have permission to copy the text into the relevant selection buffer).
+ <code>True</code> of the selection was successfully added, <code>False</code> otherwise. Selection mayfail if the object does not support selection of text (see STATE_SELECTABLE_TEXT), if theobject does not support multiple selections and a selection is already defined, or for other reasons(for instance if the user does not have permission to copy the text into the relevant selection buffer).
</tp:docstring>
</arg>
</method>
<arg direction="in" name="selectionNum" type="i"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the selection was successfully removed, \c False otherwise.
+ <code>True</code> if the selection was successfully removed, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<p>Calling setSelection for a selectionNum that is not already defined has no effect.
The result of calling setSelection with a selectionNum greater than 0 for objects that
- do not include STATE_MULTISELECTABLE is undefined.
- @param selectionNum indicates which of a set of non-contiguous selections to modify.
- @param startOffset the new starting offset for the selection
- @param endOffset the new ending offset for the selection</p>
+ do not include STATE_MULTISELECTABLE is undefined.</p>
</tp:docstring>
- <arg direction="in" name="selectionNum" type="i"/>
- <arg direction="in" name="startOffset" type="i"/>
- <arg direction="in" name="endOffset" type="i"/>
+ <arg direction="in" name="selectionNum" type="i">
+ <tp:docstring>
+ Indicates which of a set of non-contiguous selections to modify.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="startOffset" type="i">
+ <tp:docstring>
+ The new starting offset for the selection
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="endOffset" type="i">
+ <tp:docstring>
+ The new ending offset for the selection
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the selection corresponding to selectionNum is successfully modified, \c False otherwise.
+ <code>True</code> if the selection corresponding to selectionNum is successfully
+ modified, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain the bounding box which entirely contains a given text range.
Negative values may be returned for the bounding box parameters in the event
- that all or part of the text range is offscreen or not mapped to the screen.
+ that all or part of the text range is offscreen or not mapped to the screen.</p>
+ </tp:docstring>
+ <arg direction="in" name="startOffset" type="i">
+ <tp:docstring>
@param startOffset the offset of the first character in the specified range.
- @param endOffset the offset of the character immediately after the last
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="endOffset" type="i">
+ <tp:docstring>
+ The offset of the character immediately after the last
character in the specified range.
- @param x an integer parameter which is back-filled with the minimum
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="x" type="i">
+ <tp:docstring>
+ An integer parameter which is back-filled with the minimum
horizontal coordinate of the resulting bounding box.
- @param y an integer parameter which is back-filled with the minimum
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="y" type="i">
+ <tp:docstring>
+ An integer parameter which is back-filled with the minimum
vertical coordinate of the resulting bounding box.
- @param width an integer parameter which is back-filled with the
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="width" type="i">
+ <tp:docstring>
+ An integer parameter which is back-filled with the
horizontal extent of the bounding box.
- @param height an integer parameter which is back-filled with the
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="height" type="i">
+ <tp:docstring>
+ </tp:docstring>
+ An integer parameter which is back-filled with the
vertical extent of the bounding box.
- @param coordType If 0, the above coordinates are reported in pixels relative to
+ </arg>
+ <arg direction="in" name="coordType" type="n" tp:type="short">
+ <tp:docstring>
+ If 0, the above coordinates are reported in pixels relative to
corner of the screen; if 1, the coordinates are reported relative to the
- corner of the containing toplevel window.</p>
+ corner of the containing toplevel window.
</tp:docstring>
- <arg direction="in" name="startOffset" type="i"/>
- <arg direction="in" name="endOffset" type="i"/>
- <arg direction="out" name="x" type="i"/>
- <arg direction="out" name="y" type="i"/>
- <arg direction="out" name="width" type="i"/>
- <arg direction="out" name="height" type="i"/>
- <arg direction="in" name="coordType" type="n" tp:type="short"/>
+ </arg>
</method>
<method name="getBoundedRanges">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
Depending on the TEXT_CLIP_TYPE parameters, glyphs which are clipped by the
bounding box (i.e. which lie partially inside and partially outside it)
may or may not be included in the ranges returned.
- @note This method may be of particular interest to screen review algorithms.
- @see TEXT_CLIP_TYPE.
- @param x the minimum x ( i.e. leftmost) coordinate of the bounding box.
- @param y the minimum y coordinate of the bounding box.
- @param width the horizontal size of the bounding box. The rightmost bound of the bounding box
+ This method may be of particular interest to screen review algorithms.</p>
+ </tp:docstring>
+ <arg direction="in" name="x" type="i">
+ <tp:docstring>
+ The minimum x ( i.e. leftmost) coordinate of the bounding box.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="y" type="i">
+ <tp:docstring>
+ The minimum y coordinate of the bounding box.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="width" type="i">
+ <tp:docstring>
+ The horizontal size of the bounding box. The rightmost bound of the bounding box
is (x + width);
- @param height the vertical size of the bounding box. The maximum y value of the bounding box
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="height" type="i">
+ <tp:docstring>
+ The vertical size of the bounding box. The maximum y value of the bounding box
is (y + height);
- @param coordType If 0, the above coordinates are interpreted as pixels relative to
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="coordType" type="n" tp:type="short">
+ <tp:docstring>
+ If 0, the above coordinates are interpreted as pixels relative to
corner of the screen; if 1, the coordinates are interpreted as pixels relative to the
corner of the containing toplevel window.
- @param xClipType determines whether text which intersects the bounding box in the x direction
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="xClipType" type="u" tp:type="TEXT_CLIP_TYPE">
+ <tp:docstring>
+ Determines whether text which intersects the bounding box in the x direction
is included.
- @param yClipType determines whether text which intersects the bounding box in the y direction
- is included.</p>
- </tp:docstring>
- <arg direction="in" name="x" type="i"/>
- <arg direction="in" name="y" type="i"/>
- <arg direction="in" name="width" type="i"/>
- <arg direction="in" name="height" type="i"/>
- <arg direction="in" name="coordType" type="n" tp:type="short"/>
- <arg direction="in" name="xClipType" type="u" tp:type="TEXT_CLIP_TYPE"/>
- <arg direction="in" name="yClipType" type="u" tp:type="TEXT_CLIP_TYPE"/>
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="yClipType" type="u" tp:type="TEXT_CLIP_TYPE">
+ <tp:docstring>
+ Determines whether text which intersects the bounding box in the y direction
+ is included.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="a(iisv)" tp:type="RangeList"/>
</method>
<method name="getAttributeRun">
WICD (http://www.w3.org/TR/2005/WD-WICD-20051121/). Those attributes from the aforementioned
specifications and recommendations which do not concern typographic, presentational, or
semantic aspects of text should be exposed via the more general Accessible::getAttributes() API
- (if at all). </p>
+ (if at all).</p>
<p>For example, CSS attributes which should be exposed on text (either as default attributes, or
as explicitly-set attributes when non-default values are specified in the content view) include
the Font attributes (i.e. "css2:font-weight", "css2:font-style"),
the "css2:color" and "css2:background-color" attributes, and "css2:text-decoration" attribute. </p>
- <p>If includeDefaults is TRUE, then this AttributeSet should include the default
+ <p>If includeDefaults is <code>True</code>, then this AttributeSet should include the default
attributes as well as those which are explicitly assigned to the attribute run in question.
startOffset and endOffset will be back-filled to indicate the start and end of the attribute run
which contains 'offset' - an attribute run is a contiguous section of text whose attributes are
- homogeneous.
- @param offset the offset of the character whose attributes will be reported.
- @param startOffset backfilled with the starting offset of the character range over which all
- text attributes match those of \c offset, i.e. the start of the homogeneous
- attribute run including \c offset.
- @param endOffset backfilled with the offset of the first character past the character range over which all
- text attributes match those of \c offset, i.e. the character immediately after
- the homogeneous attribute run including \c offset.
- @param includeDefaults if False, the call should only return those attributes which are
- explicitly set on the current attribute run, omitting any attributes which are inherited from
- the default values. See also Text::getDefaultAttributes. </p>
+ homogeneous. </p>
- <p>@note Clients seeking annotations or properties of a more general nature, which
+ <p>Clients seeking annotations or properties of a more general nature, which
are not specific to the onscreen textual content of objects and cannot logically be applied
to specific character offset ranges,
- should use Accessible::getAttributes instead.
- The attributes returned by Text::getAttributeRun (with or without 'default attributes'),
- are distinct from the properties/attributes returned by Accessible::getAttributes. </p>
-
- <p>@see Accessible::getAttributes </p>
- </tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="out" name="startOffset" type="i"/>
- <arg direction="out" name="endOffset" type="i"/>
- <arg direction="in" name="includeDefaults" type="b" tp:type="boolean"/>
+ should use Accessible.getAttributes instead.
+ The attributes returned by Text.getAttributeRun (with or without 'default attributes'),
+ are distinct from the properties/attributes returned by Accessible.getAttributes. </p>
+ </tp:docstring>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The offset of the character whose attributes will be reported.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="startOffset" type="i">
+ <tp:docstring>
+ Backfilled with the starting offset of the character range over which all
+ text attributes match those of <code>offset</code>, i.e. the start of the homogeneous
+ attribute run including <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="endOffset" type="i">
+ <tp:docstring>
+ Backfilled with the offset of the first character past the character range over which all
+ text attributes match those of <code>offset</code>, i.e. the character immediately after
+ the homogeneous attribute run including <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="includeDefaults" type="b" tp:type="boolean">
+ <tp:docstring>
+ If False, the call should only return those attributes which are
+ explicitly set on the current attribute run, omitting any attributes which are inherited from
+ the default values. See also Text.getDefaultAttributes.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="as" tp:type="AttributeSet">
<tp:docstring>
- the AttributeSet defined at offset, optionally including the 'default' attributes. @since AT-SPI 1.7.0
+ The AttributeSet defined at offset, optionally including the 'default' attributes.
</tp:docstring>
</arg>
</method>
<method name="getDefaultAttributeSet">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Return an ::AttributeSet containing the text attributes which apply to all text in the object
+ <p>Return an AttributeSet containing the text attributes which apply to all text in the object
by virtue of the default settings of the document, view, or user agent; e.g. those
attributes which are implied rather than explicitly applied to the text object.
For instance, an object whose entire text content has been explicitly marked as 'bold' will
report the 'bold' attribute via getAttributeRun(), whereas an object whose text weight is
inspecified may report the default or implied text weight in the default AttributeSet. </p>
-
- <p>@since AT-SPI 1.7.0</p>
</tp:docstring>
<arg direction="out" type="as" tp:type="AttributeSet"/>
</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>
</interface>
</node>
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
-
-
-
-
-
-
<tp:struct name="AccessibleProxy" array-name="AccessibleProxyArray">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The wire structure of an Accessible object proxy</p>
<?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.Value">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface supporting controls which allow a
reflect a scalar quantity. (If STATE_EDITABLE is not present,
the valuator is treated as "read only". </p>
- <p>@note Events generated by Image instances include:
- \li \c "object:value-changed"</p>
+ <p>Events generated by Image instances include:
+ 'object:value-changed'</p>
</tp:docstring>
<tp:property name="minimumValue" type="d" access="read">
<tp:docstring>
The current value of the valuator.
</tp:docstring>
</tp:property>
- <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