diff options
author | Mark Doffman <mdoff@silver-wind.(none)> | 2008-05-16 16:11:40 +0100 |
---|---|---|
committer | Mark Doffman <mdoff@silver-wind.(none)> | 2008-05-16 16:16:19 +0100 |
commit | ff143bfb6c3ca9e1a7362bd7f9c7c5eba31eb135 (patch) | |
tree | 3661a3149da6031c5a0e74463fdd428738e2bf1b /cspi/spi-listener.h | |
parent | 5d01be6ec7d2cb2e662c695bd4c28c50ac3f2dab (diff) | |
download | at-spi2-atk-ff143bfb6c3ca9e1a7362bd7f9c7c5eba31eb135.tar.gz |
2008-05-16 Mark Doffman <mark.doffman@codethink.co.uk>
Re-organize the directories. The main purpose of
this change is to remove CORBA code and references
that are no longer used.
* atk-adaptor/
Code here used to live in libspi and atk-bridge.
* droute/
The droute module has been moved from libspi to
its own directory.
* spi-common
Code and definitions common to registryd and
the atk-adaptor. Mostly moved from libspi/dbus.c
and accessible.h.
* cspi/
Removed for the moment. Will have to be
mostly rewritten for D-Bus.
Diffstat (limited to 'cspi/spi-listener.h')
-rw-r--r-- | cspi/spi-listener.h | 156 |
1 files changed, 0 insertions, 156 deletions
diff --git a/cspi/spi-listener.h b/cspi/spi-listener.h deleted file mode 100644 index 364d4e3..0000000 --- a/cspi/spi-listener.h +++ /dev/null @@ -1,156 +0,0 @@ -/* - * AT-SPI - Assistive Technology Service Provider Interface - * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap) - * - * Copyright 2001, 2002 Sun Microsystems Inc., - * Copyright 2001, 2002 Ximian, Inc. - * - * 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. - * - * 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. - * - * 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. - */ - -#ifndef _SPI_LISTENER_H_ -#define _SPI_LISTENER_H_ - -#include <cspi/spi-impl.h> - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * AccessibleEvent: - * @type: a string representing the type of the event, with increasing specificity - * from left to right, delimited by colons. Leftmost token represents event source type, - * next token represents event category, and next token represents the subcategory - * of the event, for instance the specific property, state, or attribute being notified. - * @source: The #Accessible from which the event originated. - * @detail1: an event-type-specific integer value. - * @detail2: an event-type-specific integer value. - * - * A structure used to encapsulate event information. - **/ -typedef struct { - const char *type; - Accessible *source; - long detail1; - long detail2; -} AccessibleEvent; - -/** - *AccessibleDeviceEventType: - *@SPI_KEY_PRESSED: A device key has been pressed. - *@SPI_KEY_RELEASED: A device key has been released. - *@SPI_BUTTON_PRESSED: A device button or switch (other than a keyboard key) - * has been pressed. - *@SPI_BUTTON_RELEASED: A device button or switch has been released. - * - *The type of an AccessibleDeviceEvent. - **/ -typedef enum { - SPI_KEY_PRESSED = 1<<0, - SPI_KEY_RELEASED = 1<<1, - SPI_BUTTON_PRESSED = 1<<2, - SPI_BUTTON_RELEASED = 1<<3 -} AccessibleDeviceEventType; - -/** - *AccessibleKeyEventType: - * - *This is a synonym for AccessibleDeviceEventType - **/ -typedef AccessibleDeviceEventType AccessibleKeyEventType; - -/** - * AccessibleDeviceEvent: - * @keyID: Symbolic representation for the key or switch generating the event, e.g. keysym or button number. - * @keystring: A symbolic name for the key or switch, or, if is_text is true, a string approximating the - * inserted text characters which would result from this event, if a text entry field has keyboard focus. - * @timestamp: A time in ms when this event occurred, relative to some unspecified starting point. - * Timestamp values should therefore be used to compare events but should not be tested against a - * fixed time. - * @type: The #AccessibleDeviceEventType identifying the specific type of event. - * @is_text: A boolean value indicating whether the event represents 'printable' text (i.e. whether it - * changes the current insertion buffer of a focussed text entry component or not). Whitespace - * is considered "printable" in this context, since it typically inserts characters into the buffer. - * - * A structure encapsulating information relevant to a device event notification. - **/ -typedef struct { - long keyID; - short keycode; - char * keystring; - long timestamp; - AccessibleDeviceEventType type; - unsigned short modifiers; - SPIBoolean is_text; -} AccessibleDeviceEvent; - -typedef AccessibleDeviceEvent AccessibleKeystroke; - -/* - * Function prototype typedefs for Event Listener Callbacks. - * (see libspi/accessibleeventlistener.h for definition of SpiVoidEventListenerCB). - * - * usage: signatures should be - * void (*AccessibleEventListenerCB) (AccessibleEvent *event); - * - * SPIBoolean (*AccessibleKeystrokeListenerCB) (AccessibleKeystrokeEvent *Event); - * Note that AccessibleKeystrokeListeners may consume the event received - * if one of their callbacks returns TRUE (see SPI_registerAccessibleKeystrokeListener) - */ - -/** - * AccessibleEventListenerCB: - * @event: The event for which notification is sent. - * @user_data: User data which is passed to the callback each time a notification takes place. - * - * A function prototype for callbacks via which clients are notified of AT-SPI events. - * - **/ -typedef void (*AccessibleEventListenerCB) (const AccessibleEvent *event, - void *user_data); -/** - * AccessibleKeystrokeListenerCB: - * @stroke: the #AccessibleKeystroke event for which notification is taking place. - * @user_data: data passed to the callback each time it is notified, according to the data - * which was passed in when the listener/callback was registered. - * - * A function prototype for a callback function called when a key event notification takes place. - * - * Returns: %TRUE if the client wishes to consume the event and prevent its - * dispatch to other listeners or the currently focussed application, if - * the relevant callback was registered with the #SPI_KEYLISTENER_CANCONSUME flag. - **/ -typedef SPIBoolean (*AccessibleKeystrokeListenerCB) (const AccessibleKeystroke *stroke, - void *user_data); -/** - * AccessibleDeviceListenerCB: - * @stroke: The #AccessibleDeviceEvent for which notification is being received. - * @user_data: Data which is passed to the client each time this callback is notified. - * - * A callback function prototype via which clients receive device event notifications. - * - * Returns: %TRUE if the client wishes to consume/preempt the event, preventing it from being - * relayed to the currently focussed application, %FALSE if the event delivery should proceed as normal. - **/ -typedef SPIBoolean (*AccessibleDeviceListenerCB) (const AccessibleDeviceEvent *stroke, - void *user_data); - -#ifdef __cplusplus -} -#endif - -#endif |