2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2002 Ximian, Inc.
6 * 2002 Sun Microsystems Inc.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
25 #ifndef _ATSPI_TYPES_H_
26 #define _ATSPI_TYPES_H_
28 #include "glib-object.h"
30 #include "atspi-constants.h"
32 typedef struct _AtspiAccessible AtspiAccessible;
33 typedef struct _AtspiAction AtspiAction;
34 typedef struct _AtspiCollection AtspiCollection;
35 typedef struct _AtspiComponent AtspiComponent;
36 typedef struct _AtspiDocument AtspiDocument;
37 typedef struct _AtspiEditableText AtspiEditableText;
38 typedef struct _AtspiHyperlink AtspiHyperlink;
39 typedef struct _AtspiHypertext AtspiHypertext;
40 typedef struct _AtspiImage AtspiImage;
41 typedef struct _AtspiSelection AtspiSelection;
42 typedef struct _AtspiTable AtspiTable;
43 typedef struct _AtspiTableCell AtspiTableCell;
44 typedef struct _AtspiText AtspiText;
45 typedef struct _AtspiValue AtspiValue;
46 typedef struct _AtspiAccessibleReadingMaterial AtspiAccessibleReadingMaterial;
47 typedef struct _AtspiAccessibleDefaultLabelInfo AtspiAccessibleDefaultLabelInfo;
49 typedef guint AtspiControllerEventMask;
51 typedef guint AtspiKeyMaskType;
53 typedef guint AtspiKeyEventMask;
54 typedef guint AtspiDeviceEventMask;
56 // TODO: auto-generate the below structs
57 typedef struct _AtspiDeviceEvent AtspiDeviceEvent;
58 struct _AtspiDeviceEvent
69 typedef struct _AtspiEventListenerMode AtspiEventListenerMode;
70 struct _AtspiEventListenerMode
77 typedef struct _AtspiKeyDefinition AtspiKeyDefinition;
78 struct _AtspiKeyDefinition
86 typedef struct _AtspiEvent AtspiEvent;
90 AtspiAccessible *source;
97 * ATSPI_TYPE_DEVICE_EVENT:
99 * The #GType for a boxed type holding a #AtspiDeviceEvent.
101 #define ATSPI_TYPE_DEVICE_EVENT (atspi_device_event_get_type ())
106 * The #GType for a boxed type holding a #AtspiEvent.
108 #define ATSPI_TYPE_EVENT (atspi_event_get_type ())
110 typedef void AtspiKeystrokeListener;
118 * Structure containing identifying information about a set of keycode or
121 typedef struct _AtspiKeySet
130 *AtspiKeyListenerSyncType:
131 * @ATSPI_KEYLISTENER_NOSYNC: Events may be delivered asynchronously,
132 * which means in some cases they may already have been delivered to the
133 * application before the AT client receives the notification.
134 * @ATSPI_KEYLISTENER_SYNCHRONOUS: Events are delivered synchronously, before the
135 * currently focussed application sees them.
136 * @ATSPI_KEYLISTENER_CANCONSUME: Events may be consumed by the AT client. Presumes and
137 * requires #ATSPI_KEYLISTENER_SYNCHRONOUS, incompatible with #ATSPI_KEYLISTENER_NOSYNC.
138 * @ATSPI_KEYLISTENER_ALL_WINDOWS: Events are received not from the application toolkit layer, but
139 * from the device driver or windowing system subsystem; such notifications are 'global' in the
140 * sense that they are not broken or defeated by applications that participate poorly
141 * in the accessibility APIs, or not at all; however because of the intrusive nature of
142 * such snooping, it can have side-effects on certain older platforms. If unconditional
143 * event notifications, even when inaccessible or "broken" applications have focus, are not
144 * required, it may be best to avoid this enum value/flag.
146 * Specifies the type of a key listener event.
147 * The values above can and should be bitwise-'OR'-ed
148 * together, observing the compatibility limitations specified in the description of
149 * each value. For instance, #ATSPI_KEYLISTENER_ALL_WINDOWS | #ATSPI_KEYLISTENER_CANCONSUME is
150 * a commonly used combination which gives the AT complete control over the delivery of matching
151 * events. However, such filters should be used sparingly as they may have a negative impact on
152 * system performance.
155 ATSPI_KEYLISTENER_NOSYNC = 0,
156 ATSPI_KEYLISTENER_SYNCHRONOUS = 1 << 0,
157 ATSPI_KEYLISTENER_CANCONSUME = 1 << 1,
158 ATSPI_KEYLISTENER_ALL_WINDOWS = 1 << 2
159 } AtspiKeyListenerSyncType;
160 #endif /* _ATSPI_TYPES_H_ */