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 _AtspiText AtspiText;
44 typedef struct _AtspiValue AtspiValue;
46 typedef guint AtspiControllerEventMask;
48 typedef guint AtspiKeyMaskType;
50 typedef guint AtspiKeyEventMask;
51 typedef guint AtspiDeviceEventMask;
53 // TODO: auto-generate the below structs
54 typedef struct _AtspiDeviceEvent AtspiDeviceEvent;
55 struct _AtspiDeviceEvent
66 typedef struct _AtspiEventListenerMode AtspiEventListenerMode;
67 struct _AtspiEventListenerMode
74 typedef struct _AtspiKeyDefinition AtspiKeyDefinition;
75 struct _AtspiKeyDefinition
83 typedef struct _AtspiEvent AtspiEvent;
87 AtspiAccessible *source;
96 * The #GType for a boxed type holding a #AtspiEvent.
98 #define ATSPI_TYPE_EVENT (atspi_event_get_type ())
100 typedef void AtspiKeystrokeListener;
108 * Structure containing identifying information about a set of keycode or
111 typedef struct _AtspiKeySet
120 *AtspiKeyListenerSyncType:
121 * @ATSPI_KEYLISTENER_NOSYNC: Events may be delivered asynchronously,
122 * which means in some cases they may already have been delivered to the
123 * application before the AT client receives the notification.
124 * @ATSPI_KEYLISTENER_SYNCHRONOUS: Events are delivered synchronously, before the
125 * currently focussed application sees them.
126 * @ATSPI_KEYLISTENER_CANCONSUME: Events may be consumed by the AT client. Presumes and
127 * requires #ATSPI_KEYLISTENER_SYNCHRONOUS, incompatible with #ATSPI_KEYLISTENER_NOSYNC.
128 * @ATSPI_KEYLISTENER_ALL_WINDOWS: Events are received not from the application toolkit layer, but
129 * from the device driver or windowing system subsystem; such notifications are 'global' in the
130 * sense that they are not broken or defeated by applications that participate poorly
131 * in the accessibility APIs, or not at all; however because of the intrusive nature of
132 * such snooping, it can have side-effects on certain older platforms. If unconditional
133 * event notifications, even when inaccessible or "broken" applications have focus, are not
134 * required, it may be best to avoid this enum value/flag.
136 * Specifies the type of a key listener event.
137 * The values above can and should be bitwise-'OR'-ed
138 * together, observing the compatibility limitations specified in the description of
139 * each value. For instance, #ATSPI_KEYLISTENER_ALL_WINDOWS | #ATSPI_KEYLISTENER_CANCONSUME is
140 * a commonly used combination which gives the AT complete control over the delivery of matching
141 * events. However, such filters should be used sparingly as they may have a negative impact on
142 * system performance.
145 ATSPI_KEYLISTENER_NOSYNC = 0,
146 ATSPI_KEYLISTENER_SYNCHRONOUS = 1,
147 ATSPI_KEYLISTENER_CANCONSUME = 2,
148 ATSPI_KEYLISTENER_ALL_WINDOWS = 4
149 } AtspiKeyListenerSyncType;
150 #endif /* _ATSPI_TYPES_H_ */