-<tp:spec
- xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
- xmlns:xi="http://www.w3.org/2001/XInclude">
+<?xml version="1.0" encoding="UTF-8"?>
+<tp:spec xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" xmlns:xi="http://www.w3.org/2001/XInclude">
+
-<tp:title>AT-SPI D-Bus Interface Specification</tp:title>
<tp:version>1.24.0</tp:version>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001-2005 Ximian, Inc. and Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
-<p>This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Library General Public
-License as published by the Free Software Foundation; either
-version 2 of the License, or (at your option) any later version.</p>
-<p>This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-Library General Public License for more details.</p>
-<p>You should have received a copy of the GNU Library General Public
-License along with this library; if not, write to the
-Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.</p>
-</tp:license>
+
<tp:docstring>
!\mainpage AT-SPI Interfaces and Subinterfaces
+++ /dev/null
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
-
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
-
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
-
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
-<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
- accessibility services (servers) can rendezvous with consumers of those
- services (Assistive Technologies). The Registry is the first "port of call" for
- accessible applications and for assistive technologies wishing to query and
- 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>
-
- <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
- 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
- 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>
- </tp:docstring>
- <method name="registerApplication">
- <tp:docstring>
- Register a new application with the accessibility broker.
- </tp:docstring>
- <arg direction="in" name="app" type="o" tp:type="Application">
- <tp:docstring>
- a reference to the requesting Application
- </tp:docstring>
- </arg>
- </method>
- <method name="deregisterApplication">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>De-register an application previously registered with the broker.
- deregisterApplication:</p>
- </tp:docstring>
- <arg direction="in" name="app" type="o" tp:type="Application">
- <tp:docstring>
- a reference to the Application to be deregistered.
- </tp:docstring>
- </arg>
- </method>
- <method name="registerGlobalEventListener">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Register a client's interest in (all) application events of
- a certain type.</p>
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="EventListener">
- <tp:docstring>
- 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.
- </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.
- </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
- </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.
- </tp:docstring>
- </arg>
- </method>
- <method name="getDesktopCount">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>event types: "Window" "Desktop"
- "Window:Create" "Window:Destroy"
- "Window:Iconify" "Window:Restore"
- "Window:Fullscreen" "Window:Resize"
- "Desktop:Create" "Desktop:Destroy"
- "Desktop:Focus" "Desktop:Defocus"
- "Desktop:Reorder"
- "Focus"
- "GtkWidget:show"
- "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.
- </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.
- </tp:docstring>
- </arg>
- </method>
- <method name="getDesktopList">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Get a list of accessible desktops. </p>
- </tp:docstring>
- <arg direction="out" type="as" tp:type="DesktopSeq">
- <tp:docstring>
- a sequence containing references tothe Desktops.
- </tp:docstring>
- </arg>
- </method>
- <method name="getDeviceEventController">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Obtain an object which can be used to request device event notifications. </p>
- </tp:docstring>
- <arg direction="out" type="o" tp:type="DeviceEventController">
- <tp:docstring>
- an object implementing DeviceEventController
- </tp:docstring>
- </arg>
- </method>
-</interface>
-<tp:enum name="KeyEventType" type="u">
- <tp:docstring>
- Deprecated, DO NOT USE!
- </tp:docstring>
- <tp:enumvalue suffix="KEY_PRESSED"/>
- <tp:enumvalue suffix="KEY_RELEASED" value="1"/>
-</tp:enum>
-<tp:enum name="EventType" type="u">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Used to specify the event types of interest to an EventListener, or
- to identify the type of an event for which notification has been sent.
- @see EventTypeSeq, DeviceEvent::type</p>
- </tp:docstring>
- <tp:enumvalue suffix="KEY_PRESSED_EVENT">
- <tp:docstring>
- < key on a keyboard device was pressed.
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="KEY_RELEASED_EVENT" value="1">
- <tp:docstring>
- < key on a keyboard device was released.
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="BUTTON_PRESSED_EVENT" value="2">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< button on a non-keyboard human interface device
- (HID) was pressed </p>
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="BUTTON_RELEASED_EVENT" value="3">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< button on a non-keyboard human interface device
- (HID) was pressed </p>
- </tp:docstring>
- </tp:enumvalue>
-</tp:enum>
-<tp:enum name="KeySynthType" type="u">
- <tp:docstring>
- Used when synthesizing keyboard input via DeviceEventController:generateKeyboardEvent.
- </tp:docstring>
- <tp:enumvalue suffix="KEY_PRESS">
- <tp:docstring>
- emulate the pressing of a hardware keyboard key.
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="KEY_RELEASE" value="1">
- <tp:docstring>
- emulate the release of a hardware keyboard key.
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="KEY_PRESSRELEASE" value="2">
- <tp:docstring>
- a hardware keyboard key is pressed and immediately released.
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="KEY_SYM" value="3">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>a symbolic key event is generated, without specifying a hardware key.
- @note if the keysym is not present in the current keyboard map,
- the DeviceEventController instance has a limited ability to generate
- such keysyms on-the-fly. Reliability of generateKeyboardEvent calls
- using out-of-keymap keysyms will vary from system to system, and on the
- number of different out-of-keymap being generated in quick succession.
- In practice this is rarely significant, since the keysyms of interest to
- AT clients and keyboard emulators are usually part of the current keymap, i.e.
- present on the system keyboard for the current locale (even if a physical
- hardware keyboard is not connected.</p>
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="KEY_STRING" value="4">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>a string is converted to its equivalent keyboard events and emitted.
- If the string consists of complex character or composed characters
- which are not in the current keymap, string emission is subject to the
- out-of-keymap limitations described for KeySynthType::KEY_SYM.
- In practice this limitation primarily effects Chinese and Japanese locales.</p>
- </tp:docstring>
- </tp:enumvalue>
-</tp:enum>
-<tp:enum name="ModifierType" type="u">
- <tp:enumvalue suffix="MODIFIER_SHIFT">
- <tp:docstring>
- The left or right 'Shift' key
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="MODIFIER_SHIFTLOCK" value="1">
- <tp:docstring>
- The ShiftLock or CapsLock key
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="MODIFIER_CONTROL" value="2">
- <tp:docstring>
- 'Control'/'Ctrl'
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="MODIFIER_ALT" value="3">
- <tp:docstring>
- The Alt key (as opposed to AltGr)
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="MODIFIER_META" value="4">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>depending on the platform this may map to 'Window', 'Function', 'Meta',
- 'Menu', or 'NumLock'.
- Such 'Meta keys' will map to one of META, META2, META3.
- On X Windows platforms these META values map to
- the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an event having
- ModifierType::MODIFIER_META2 means that the 'Mod2Mask' bit is
- set in the corresponding XEvent.</p>
- </tp:docstring>
- </tp:enumvalue>
- <tp:enumvalue suffix="MODIFIER_META2" value="5"/>
- <tp:enumvalue suffix="MODIFIER_META3" value="6"/>
- <tp:enumvalue suffix="MODIFIER_NUMLOCK" value="7">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>A symbolic meta key name that is mapped by AT-SPI to the
- appropriate META value, for the convenience of the client.</p>
- </tp:docstring>
- </tp:enumvalue>
-</tp:enum>
-<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 True, 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 \c True, 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 \c True, 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.
- @note
- 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:
- \li \c 1<<::MODIFIER_SHIFT (=1, corresponds to Xlib's ShiftMask)
- \li \c 1<<::MODIFIER_SHIFTLOCK (=2, corresponds to Xlib's LockMask)
- \li \c 1<<::MODIFIER_CONTROL (=4, corresponds to Xlib's ControlMask)
- \li \c 1<<::MODIFIER_ALT (=8, corresponds to Xlib's Mod1Mask)
- \li \c 1<<::MODIFIER_META (=16, corresponds to Xlib's Mod2Mask)
- \li \c 1<<::MODIFIER_META2 (=32, corresponds to Xlib's Mod3Mask)
- \li \c 1<<::MODIFIER_META3 (=64, corresponds to Xlib's Mod4Mask)</p>
- </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
- \c True, 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>< \c True if the event results in the insertion of characters
- into an input text buffer, or would do so if delivered to a focussed
- text input field. ¨Typographical¨ key events have this field set to
- \c True, whereas ¨control¨ key events generally do not.</p>
- </tp:docstring>
- </tp:member>
-</tp:struct>
-<tp:struct name="KeyDefinition">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>A structure which defines the identity of a key for which notifications
- are to be requested. The data in the members of a ::KeyDefinition are used to
- determine which keyboard events 'match' the notification request filed by a client. </p>
-
- <p>@note Ordinarily a KeyDefinition specifies one and only one of the criteria below;
- the result of using a KeyDefinition with multiple members defined as nonzero is
- undefined. </p>
-
- <p>@param keycode 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 \c keysym based notifications, but some hardware (notably many laptops) may generate
- more than one keycode for the same physical key, depending on the state of physical
- shift/modifier keys.
- @param keysym if nonzero, the numeric value corresponding to the X Keysym of the key for which
- 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.
- @param keystring if non-NULL, the string value of the inserted characters if the corresponding
- key event has ::KeyEvent:is_text set to \c True, or the string representing the
- 'name' of the key. On X11 systems, the string 'name' of non-printing keysyms corresponds
- to the values in "keysymdef.h" as provided by Xlib, with the leading "XK_" stripped off.</p>
- </tp:docstring>
- <tp:member type="i" tp:name="keycode"/>
- <tp:member type="i" tp:name="keysym"/>
- <tp:member type="s" tp:name="keystring"/>
- <tp:member type="i" tp:name="unused"/>
-</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>
- \c True if the recipient/consumer wishes to consume the event, i.e.prevent it from being delivered to the desktop, \c False if the event should continue to be delivered as normal.
- </tp:docstring>
- </arg>
- </method>
-</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.@note Some platforms have limited support for global, preemptive EventListenerMode.Such a registration may fail if another client already has priority for preemptiveaccess to one or more of the members of the KeySet. AT consumers have the optionof re-trying the request without the global flag, or without the preemptive flag,or of re-trying with a different KeySet. The best support for pre-emptiveglobal keyboard listeners is provided on platforms whose Xserver implementationprovides the XEvIE extension.
- </tp:docstring>
- </arg>
- <arg direction="out" type="b" tp:type="boolean">
- <tp:docstring>
- \c True if the DeviceEventListener was successfully registeredfor the requested KeySet, ControllerEventMask, event types, and EventListenerMode; otherwise returns \c False.
- </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>
- \c True if successful, \c False 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>@note AT clients do not normally need to use this method, it is intended for use
- by toolkit bridges and special-purpose applications. </p>
- </tp:docstring>
- <arg direction="in" name="event" type="(uinnisb)" tp:type="DeviceEvent"/>
- <arg direction="out" type="b" tp:type="boolean">
- <tp:docstring>
- \c True if the event was consumed by a (pre-emptive) listener,\c False if not (in which case the device event will be forwardedas normal to any application which would normally receive it, e.g.the currently active application in the case of mouse or keyboard events).
- </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>
-
- <p>@note AT clients do not normally need to use this method, it is intended for use
- by toolkit bridges and special-purpose applications.</p>
- </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>
- a KeySynthType indicating the type of event(s) to be synthesized: a key press, release, press-release pair,or a complex input string (for instance from aninternationalized or complex text input method, ora composed character).@note keycode may be truncated before beingprocessed, as keycode length may be platform-dependentand keycode ranges are generally much smaller thanCORBA_long. One or the other of keycode or keystring are generally NULL, (but not both), depending on the value of \c type.
- </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>
-</node>
org.freedesktop.atspi.Hypertext.xml \
org.freedesktop.atspi.Image.xml \
org.freedesktop.atspi.LoginHelper.xml \
- Accessibility_Registry_Common.xml \
+ org.freedesktop.atspi.Registry.Common.xml \
org.freedesktop.atspi.Registry.xml \
org.freedesktop.atspi.DeviceEventController.xml \
org.freedesktop.atspi.DeviceEventListener.xml \
- Accessibility_Relation.xml \
- Accessibility_Role.xml \
+ org.freedesktop.atspi.Relation.xml \
+ org.freedesktop.atspi.Role.xml \
org.freedesktop.atspi.Selection.xml \
org.freedesktop.atspi.Selector.xml \
- Accessibility_State.xml \
+ org.freedesktop.atspi.State.xml \
org.freedesktop.atspi.StreamableContent.xml \
org.freedesktop.atspi.Table.xml \
org.freedesktop.atspi.Text.xml \
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<tp:enum name="LOCALE_TYPE" type="u">
<tp:docstring>
used by Text and Document: these correspond to the POSIX setlocale() enum values.
actually have children. </p>
<p>@note Events that may be emitted by instances of Accessible include:
- \li \c "object:property-change" A base (strongly-typed) object attribute has changed,
- for instance "object:property-change:accessible-name".
+ \li \c "object:property-change" A base (strongly-typed) object attribute has changed,
+ for instance "object:property-change:accessible-name".
Notifed property subtypes include accessible-name, accessible-description,
accessible-parent and accessible-role. </p>
- <p>\li \c "object:children-changed" The number or identity of an object's children
+ <p>\li \c "object:children-changed" The number or identity of an object's children
has changed.
- \li \c "object:state-changed" The object's StateSet has had a state added
+ \li \c "object:state-changed" The object's StateSet has had a state added
or removed.
- \li \c "object:active-descendant-changed" If the object includes
+ \li \c "object:active-descendant-changed" If the object includes
STATE_MANAGES_DESCENDANTS, this event is fired to indicate that the
descendant having STATE_ACTIVE has changed; this corresponds to
- "micro" keyboard focus when the containing/emitting object has
- "macro" or technical keyboard focus. For instance, this event is
+ "micro" keyboard focus when the containing/emitting object has
+ "macro" or technical keyboard focus. For instance, this event is
usually emitted while traversing tables and/or spreadsheet cells.
- \li \c "object:attribute-change" A weakly-typed property, as contained in the
+ \li \c "object:attribute-change" A weakly-typed property, as contained in the
AttributeSet returned by Accessible::getAttributes, has changed in value,
been added, or been removed from the object.
- ("object:attribute-change" notifications were added in AT-SPI 1.7.0)</p>
+ ("object:attribute-change" notifications were added in AT-SPI 1.7.0)</p>
</tp:docstring>
<tp:property name="name" type="s" access="readwrite">
<tp:docstring>
::AttributeSet consisting of name-value pairs. As such these attributes
may be considered weakly-typed properties or annotations, as distinct
from the strongly-typed interface instance data declared using the IDL
- "attribute" keyword. </p>
+ "attribute" keyword. </p>
- <p>Not all objects have explicit "name-value pair" AttributeSet properties. </p>
+ <p>Not all objects have explicit "name-value pair" AttributeSet properties. </p>
<p>Attribute names and values may have any UTF-8 string value, however where possible,
- in order to facilitate consistent use and exposure of "attribute" properties by
+ in order to facilitate consistent use and exposure of "attribute" properties by
applications and AT clients, attribute names and values should chosen from
a publicly-specified namespace where appropriate. </p>
<p>@note Clients seeking semantic or typographical attributes associated with
specific character spans of text content should use ::Text::getAttributeRun instead.
The attributes returned by Accessible::getAttributes do not include
- "text attributes". </p>
+ "text attributes". </p>
<p>@see ::Accessibility::Text::getAttributeRun </p>
</tp:docstring>
<arg direction="out" type="as" tp:type="AttributeSet">
<tp:docstring>
- an ::AttributeSet encapsulating any "attribute values" currently defined for the object.@since AT-SPI 1.7.0
+ an ::AttributeSet encapsulating any "attribute values" currently defined for the object.@since AT-SPI 1.7.0
</tp:docstring>
</arg>
</method>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi/Action">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface through which a user-actionable user interface
component can be manipulated. Components which react to mouse or
keyboard input from the user, (with the exception of pure text entry
fields with no other function), should implement this interface.
- Typical actions include "click", "press", "release" (for instance for
- buttons), "menu" (for objects which have context menus invokable from
- mouse or keyboard), "open" for icons representing files folders, and others.</p>
+ Typical actions include "click", "press", "release" (for instance for
+ buttons), "menu" (for objects which have context menus invokable from
+ mouse or keyboard), "open" for icons representing files folders, and others.</p>
</tp:docstring>
<tp:struct name="Action">
<tp:member type="s" tp:name="name">
</tp:member>
<tp:member type="s" tp:name="keyBinding">
<tp:docstring>
- a \c string containing the key binding for the specified action,or an empty string ("") if none exists.
+ a \c string containing the key binding for the specified action,or an empty string ("") if none exists.
</tp:docstring>
</tp:member>
</tp:struct>
<method name="getName">
<tp:docstring>
- <p>Get the name of the specified action. Action names generally describe the user action, i.e. "click" or "press", rather than the result of invoking the action.</p>
+ <p>Get the name of the specified action. Action names generally describe the user action, i.e. "click" or "press", rather than the result of invoking the action.</p>
</tp:docstring>
<arg type="i" name="index" direction="in">
<tp:docstring>the index of the action</tp:docstring>
<tp:docstring>the index of the action</tp:docstring>
</arg>
<arg type="s" direction="out">
- <tp:docstring>A string containing the key binding for the specified action, or an empty string ("") if none exists.</tp:docstring>
+ <tp:docstring>A string containing the key binding for the specified action, or an empty string ("") if none exists.</tp:docstring>
</arg>
</method>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001-2004 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi.Application">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface identifying an object which is the root of the
Children of Application are typically, but not exclusively,
top-level windows.
@note It is possible for an element deeper in an Accessibility stack to
- implement Application, for instance in the case of "embedded applications"
+ implement Application, for instance in the case of "embedded applications"
which draw into toplevel windows associated with other applications
from the user's point of view.</p>
</tp:docstring>
</arg>
<arg direction="in" name="eventName" type="s">
<tp:docstring>
- a UTF-8 string indicating the type of (toolkit-specific) eventbeing requested. Not all applications can generate toolkit events ofa given type.Register with this application's toolkit for "toolkit-specific" event notifications.@noteFor most event support, clients should use non-toolkit-specific eventswhenever possible, via ::Registry::registerGlobalEventListener - this method is provided as a 'back door' when generic names do not exist for the events in question.
+ a UTF-8 string indicating the type of (toolkit-specific) eventbeing requested. Not all applications can generate toolkit events ofa given type.Register with this application's toolkit for "toolkit-specific" event notifications.@noteFor most event support, clients should use non-toolkit-specific eventswhenever possible, via ::Registry::registerGlobalEventListener - this method is provided as a 'back door' when generic names do not exist for the events in question.
</tp:docstring>
</arg>
</method>
</arg>
<arg direction="in" name="eventName" type="s">
<tp:docstring>
- a UTF-8 string indicating the type of (toolkit-specific) eventbeing requested. Register with this application toolkit for "Accessibility::Accessible" event notifications. @note: SUBJECT TO DEPRECATION.
+ a UTF-8 string indicating the type of (toolkit-specific) eventbeing requested. Register with this application toolkit for "Accessibility::Accessible" event notifications. @note: SUBJECT TO DEPRECATION.
</tp:docstring>
</arg>
</method>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2005 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi.Collection">
<tp:enum name="SortOrder" type="u">
<tp:enumvalue suffix="SORT_ORDER_INVALID"/>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<tp:enum name="ComponentLayer" type="u">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The ComponentLayer of a Component instance indicates its relative stacking order
\li 1 indicates coord_type_xy_window, coordinates are relative to the current toplevel window, in pixels. </p>
<p>@note Events emitted by Component instances include:
- \li \c "object:bounds-changed"
- \li \c "object:visible-data-changed"</p>
+ \li \c "object:bounds-changed"
+ \li \c "object:visible-data-changed"</p>
</tp:docstring>
<method name="contains">
<arg direction="in" name="x" type="i"/>
<method name="getMDIZOrder">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain the relative stacking order (i.e. 'Z' order) of an object.
- Larger values indicate that an object is on "top" of the stack, therefore
+ Larger values indicate that an object is on "top" of the stack, therefore
objects with smaller MDIZOrder may be obscured by objects with a larger MDIZOrder,
but not vice-versa.
@note only relevant for objects in LAYER_MDI or LAYER_WINDOW </p>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi.Desktop">
<tp:property name="childCount" type="i" access="read">
<tp:docstring>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<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
<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"
+ method used by accessibility bridges to forward "toolkit dependent"
device events to the Registry from the application's process space. </p>
<p>@note AT clients do not normally need to use this method, it is intended for use
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Notify the Registry instance that a device event has taken place in
an asynchronous manner. This is the
- method used by accessibility bridges to forward "toolkit dependent"
+ method used by accessibility bridges to forward "toolkit dependent"
device events to the Registry from the application's process space.
If the event in question is potentially pre-emptible.
::notifyListenersSync should be used instead. </p>
</arg>
<arg direction="in" name="eventName" type="s">
<tp:docstring>
- a string indicating the type of mouse event, e.g. "button1up"
+ a string indicating the type of mouse event, e.g. "button1up"
</tp:docstring>
</arg>
</method>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<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
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2005 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi.Document">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Primarily a 'tagging' interface which indicates the start of
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi.EditableText">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Derived from interface Text, EditableText provides methods for
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi.Hyperlink">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Instances of Hyperlink are returned by Hypertext objects, and are
the means by which end users and clients interact with linked, and in
- some cases embedded, content. Hyperlinks may have multiple "anchors",
+ some cases embedded, content. Hyperlinks may have multiple "anchors",
where an anchor corresponds to a reference to a particular resource with
a corresponding resource identified (URI). Hyperlinks may be
queried for their URIs, or queried for the objects corresponding to their
and may be queried, and manipulated via the Action interface. </p>
<p>@note A Hyperlink implementor is normally NOT an Accessible;
- the preferred usage is for a Hyperlink's associated "objects"
+ the preferred usage is for a Hyperlink's associated "objects"
(accessed via the ::getObject method) are Accessibles. This means
- that Actions such as "open link" are normally invoked on
+ that Actions such as "open link" are normally invoked on
the result of Hyperlink::getObject rather than directly on the
Hyperlink instance. For historical reasons some implementors of Hyperlink
implement Action as well. This usage on the part of implementing
Hyperlink::numAnchors - 1, inclusive) associated with a Hyperlink.
The objects returned are usually actionable (i.e. they should implement
Accessibility::Action), and the available actions often include
- "open", "bookmark", "save link as", etc. They may also implement
+ "open", "bookmark", "save link as", etc. They may also implement
Accessibility::StreamableContent, although clients can normally use
::getURI to obtain a resource locator via which the object's
data may be accessed. </p>
<p>@note the most common application for 'multi anchor'
- hyperlinks in HTML is probably "client side imagemaps".
+ hyperlinks in HTML is probably "client side imagemaps".
A clickable image which uses the HTML 'usemap' attribute
should have one anchor for every <area> element that
includes an HREF. The objects corresponding to these map
<method name="getURI">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain a resource locator ('URI') which can be used to
- access the content to which this link "points" or is connected.</p>
+ access the content to which this link "points" or is connected.</p>
</tp:docstring>
<arg direction="in" name="i" type="i"/>
<arg direction="out" type="s">
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi.Hypertext">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface used for objects which implement linking between
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 - 2005 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi.Image">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface implemented by objects which render image data or
pictorial information to the screen. When onscreen components include
- graphical information that is not purely intended to enhance "3d effect"
+ graphical information that is not purely intended to enhance "3d effect"
or visual layout, but which conveys some semantic or informational
content to the sighted user, they should implement Image, and that
semantic content should be conveyed textually to the extent possible
of what is visually depicted in the image. </p>
<p>@note It is recommended that imageDescription be the shorter
- of the available image descriptions, for instance "alt text"
+ of the available image descriptions, for instance "alt text"
in HTML images, and a longer description be provided in
Accessible::accessible-description, if available.
A short, one or two word label for the image should be provided in
any viewport clipping or the fact that the image may be
partially or wholly obscured by other onscreen content.
@note This method returns the size of the current onscreen
- view, and not the nominal or "original" size of the source
+ view, and not the nominal or "original" size of the source
image, in the event that the original image has been rescaled. </p>
<p>@param width Back-filled with the x extents of the
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi.LoginHelper">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>@brief An interface for use by assistive technologies by which
</tp:docstring>
<arg 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.
+ \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.
</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>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<tp:enum name="KeyEventType" type="u">
<tp:docstring>
Deprecated, DO NOT USE!
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>< If \c True, specifies that
Listener is allowed to pre-empt the delivery of the event,
- effectively "consuming" it such that it is not delivered
+ effectively "consuming" it such that it is not delivered
to the currently focussed desktop application.
Key events consumed via this API will not be
available for use by other applications or services, so this
currently focussed application participates in the AT-SPI
infrastructure. On systems with the XEvIE X extension, this flag
also allows access to events which are already subject to
- interception via a "system keygrab" (as described in the X Window System
+ interception via a "system keygrab" (as described in the X Window System
documentation for XGrabKey). The 'global' and 'preemptive' flags
should only be used together for the purposes of registering
- "system global key shortcuts" i.e. command keys for use by the
+ "system global key shortcuts" i.e. command keys for use by the
assistive technology. </p>
</tp:docstring>
</tp:member>
<p>@param keycode if nonzero, the numeric, system-dependent value corresponding to a
physical key on the keyboard. Keycode values have no semantic meaning to the end-user,
and may depend on the user's hardware and operating environment. They therefore are
- rarely useful "as-is" to AT clients, unless the client has used operating system
+ rarely useful "as-is" to AT clients, unless the client has used operating system
services to identify the hardward keycode associated with a particular key symbol.
Notifications for key events requested by keycode are less dependent on modifier state
than \c keysym based notifications, but some hardware (notably many laptops) may generate
shift/modifier keys.
@param keysym if nonzero, the numeric value corresponding to the X Keysym of the key for which
notification is requested. Note that the presence of active modifiers will affect
- whether notification for key events requested via "keysym" specification takes place,
+ whether notification for key events requested via "keysym" specification takes place,
since the keysym depends on the modifier state for most keys.
@param keystring if non-NULL, the string value of the inserted characters if the corresponding
key event has ::KeyEvent:is_text set to \c True, or the string representing the
'name' of the key. On X11 systems, the string 'name' of non-printing keysyms corresponds
- to the values in "keysymdef.h" as provided by Xlib, with the leading "XK_" stripped off.</p>
+ to the values in "keysymdef.h" as provided by Xlib, with the leading "XK_" stripped off.</p>
</tp:docstring>
<tp:member type="i" tp:name="keycode"/>
<tp:member type="i" tp:name="keysym"/>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<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
accessibility services (servers) can rendezvous with consumers of those
- services (Assistive Technologies). The Registry is the first "port of call" for
+ services (Assistive Technologies). The Registry is the first "port of call" for
accessible applications and for assistive technologies wishing to query and
interact with those applications. </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>
+ @image html "http://developer.gnome.org/projects/gap/tech-docs/SPIBlockDiagram.png" </p>
<p>@see Desktop, Application, Event, EventListener</p>
</tp:docstring>
</method>
<method name="getDesktopCount">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>event types: "Window" "Desktop"
- "Window:Create" "Window:Destroy"
- "Window:Iconify" "Window:Restore"
- "Window:Fullscreen" "Window:Resize"
- "Desktop:Create" "Desktop:Destroy"
- "Desktop:Focus" "Desktop:Defocus"
- "Desktop:Reorder"
- "Focus"
- "GtkWidget:show"
- "GObject:notify:<propertyname>" </p>
+ <p>event types: "Window" "Desktop"
+ "Window:Create" "Window:Destroy"
+ "Window:Iconify" "Window:Restore"
+ "Window:Fullscreen" "Window:Resize"
+ "Desktop:Create" "Desktop:Destroy"
+ "Desktop:Focus" "Desktop:Defocus"
+ "Desktop:Reorder"
+ "Focus"
+ "GtkWidget:show"
+ "GObject:notify:<propertyname>" </p>
<p>( not sure we should allow these last 2 forms,
since they are toolkit-specific, but they're powerful ) </p>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<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)
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<tp:enum name="Role" type="u">
<tp:enumvalue suffix="ROLE_INVALID">
<tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_RADIO_MENU_ITEM" value="45">
<tp:docstring>
- Object is both a menu item and a "radio button" (see ROLE_RADIO_BUTTON)
+ Object is both a menu item and a "radio button" (see ROLE_RADIO_BUTTON)
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_ROOT_PANE" value="46">
<tp:enumvalue suffix="ROLE_EMBEDDED" value="78">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The object is an embedded component container. This role is a
- "grouping" hint that the contained objects share a context which is
+ "grouping" hint that the contained objects share a context which is
different from the container in which this accessible is embedded.
In particular, it is used for some kinds of document embedding, and
- for embedding of out-of-process component, "panel applets", etc.</p>
+ for embedding of out-of-process component, "panel applets", etc.</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_ENTRY" value="79">
</tp:enumvalue>
<tp:enumvalue suffix="ROLE_LINK" value="88">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>The object is a hypertext anchor, i.e. a "link" in a
+ <p>The object is a hypertext anchor, i.e. a "link" in a
hypertext document. Such objects are distinct from 'inline'
content which may also use the Hypertext/Hyperlink interfaces
to indicate the range/location within a text object where
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<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>
+ in other words it is an "input method window." </p>
<p>@since AT-SPI 1.7.6</p>
</tp:docstring>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<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,
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
+ \li \c "object:selection-changed" 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 \c "object:state-changed:selected" 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>
<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>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<tp:struct name="Command">
<tp:docstring>
A structure which encapsulates both a string representation of a command and a unique command ID
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<tp:enum name="StateType" type="u">
<tp:enumvalue suffix="STATE_INVALID"/>
<tp:enumvalue suffix="STATE_ACTIVE" value="1">
<tp:enumvalue suffix="STATE_ENABLED" value="8">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Indicates that this object is enabled, i.e. that it currently reflects some application state.
- Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user
+ Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user
interaction cannot cause them to acquire STATE_ENABLED. @see STATE_SENSITIVE.</p>
</tp:docstring>
</tp:enumvalue>
<p>Indicates this object is sensitive, e.g. to user interaction.
STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls,
but may be found in the absence of STATE_ENABLED if the current visible state of the
- control is "disconnected" from the application state. In such cases, direct user interaction
+ control is "disconnected" from the application state. In such cases, direct user interaction
can often result in the object gaining STATE_SENSITIVE, for instance if a user makes
an explicit selection using an object whose current state is ambiguous or undefined.
@see STATE_ENABLED, STATE_INDETERMINATE. </p>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Indicates this object, the object's parent, the object's parent's
parent, and so on, are all 'shown' to the end-user, i.e.
- subject to "exposure" if blocking or obscuring objects do not interpose
+ subject to "exposure" if blocking or obscuring objects do not interpose
between this object and the top of the window stack.</p>
</tp:docstring>
</tp:enumvalue>
</tp:enumvalue>
<tp:enumvalue suffix="STATE_MANAGES_DESCENDANTS" value="31">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Indicates that "active-descendant-changed" event is sent when children
+ <p>Indicates that "active-descendant-changed" event is sent when children
become 'active' (i.e. are selected or navigated to onscreen). Used to
prevent need to enumerate all children in very large containers, like
tables. The presence of STATE_MANAGES_DESCENDANTS is an indication to the client.
<p>Indicates that a check box or other boolean indicator is in a state other than
checked or not checked. This usually means that the boolean value reflected or
controlled by the object does not apply consistently to the entire current context.
- For example, a checkbox for the "Bold" attribute of text may have STATE_INDETERMINATE
+ For example, a checkbox for the "Bold" attribute of text may have STATE_INDETERMINATE
if the currently selected text contains a mixture of weight attributes.
In many cases interacting with a STATE_INDETERMINATE object will cause
the context's corresponding boolean attribute to be homogenized, whereupon the object
<tp:enumvalue suffix="STATE_IS_DEFAULT" value="39">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<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
+ 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>
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<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
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<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>
+ interface may be used to represent "spreadsheets" as well as "frames". </p>
<p>Objects within tables are children of the Table instance, and they may be referenced
either via a child index or via a row/column pair.
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<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
<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
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
+ \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,
+ \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
+ \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
+ \li \c "object:text-selection-changed" The range or number of text selections within this text object
has changed. </p>
<p>@note In some cases, objects which are not onscreen may implement Text, but if such objects
<method name="getText">
<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
+ "-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
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>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
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>
<arg direction="out" name="defined" type="b" tp:type="boolean"/>
<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>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain the number of separate, contiguous selections in the current Text object.
Text objects which do not implement selection of discontiguous text regions will always
- return '0' or '1'. Note that "contiguous" is defined by continuity of the offsets, i.e.
+ return '0' or '1'. Note that "contiguous" is defined by continuity of the offsets, i.e.
a text 'selection' is defined by a start/end offset pair. In the case of bidirectional text,
this means that a continguous selection may appear visually discontiguous, and vice-versa. </p>
</tp:docstring>
<method name="getAttributeRun">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Query a particular text object for the text attributes defined at a given offset,
- obtaining the start and end of the "attribute run" over which these attributes are currently
+ obtaining the start and end of the "attribute run" over which these attributes are currently
invariant. Text attributes are those presentational, typographic, or semantic attributes or
qualitites which apply to a range of text specifyable by starting and ending offsets.
Attributes relevant to localization should be provided in
- accordance with the w3c "Internationalization and Localization Markup Requirements",
+ accordance with the w3c "Internationalization and Localization Markup Requirements",
http://www.w3.org/TR/2005/WD-itsreq-20051122/
Other text attributes should choose their names and value semantics in accordance with relevant
standards such as CSS level 2 (http://www.w3.org/TR/1998/REC-CSS2-19980512),
<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>
+ 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
attributes as well as those which are explicitly assigned to the attribute run in question.
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
- <tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
- <tp:copyright>Copyright 2008 Codethink Ltd.</tp:copyright>
- <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
- <tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
- <tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
+
+
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
-
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
- </tp:license>
<tp:struct name="AccessibleProxy" array-name="AccessibleProxyArray">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
+
+
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
<interface name="org.freedesktop.atspi.Value">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>An interface supporting controls which allow a
one-dimensional, scalar quantity to be modified or which
reflect a scalar quantity. (If STATE_EDITABLE is not present,
- the valuator is treated as "read only". </p>
+ the valuator is treated as "read only". </p>
<p>@note Events generated by Image instances include:
- \li \c "object:value-changed"</p>
+ \li \c "object:value-changed"</p>
</tp:docstring>
<tp:property name="minimumValue" type="d" access="read">
<tp:docstring>
projects / platform / core / uifw / at-spi2-atk.git / commitdiff