[g-a-devel]at-spi version 1.1.5, API frozen for GNOME 2.2

[Bill Haneman <bill haneman sun com>]

Hi:

I attach the final API patch for GNOME 2.2, at-spi version 1.1.5.

It adds declarations for the a number of new event accessor methods (see
the patch to spi.h for details).

These accessor implementations do not all return useful values yet but
they are guaranteed to return legal values, even if those values are
NULL.

The patch also addresses a few of the issues Michael raised, but in the
interests of stability I am deferring a couple of the non-API-related
fixes until after Monday's GNOME 2.1.3 release.

regards,

Bill
==============


Index: configure.in
===================================================================
RCS file: /cvs/gnome/at-spi/configure.in,v
retrieving revision 1.55
diff -u -r1.55 configure.in
--- configure.in	21 Nov 2002 15:33:48 -0000	1.55
+++ configure.in	22 Nov 2002 14:38:41 -0000
@@ -2,9 +2,9 @@
 
 AT_SPI_MAJOR_VERSION=1
 AT_SPI_MINOR_VERSION=1
-AT_SPI_MICRO_VERSION=4
+AT_SPI_MICRO_VERSION=5
 AT_SPI_INTERFACE_AGE=0
-AT_SPI_BINARY_AGE=4
+AT_SPI_BINARY_AGE=5
 AT_SPI_VERSION="$AT_SPI_MAJOR_VERSION.$AT_SPI_MINOR_VERSION.$AT_SPI_MICRO_VERSION"
 AM_INIT_AUTOMAKE(at-spi, $AT_SPI_VERSION)
 AC_SUBST(AT_SPI_MAJOR_VERSION)
Index: cspi/spi.h
===================================================================
RCS file: /cvs/gnome/at-spi/cspi/spi.h,v
retrieving revision 1.53
diff -u -r1.53 spi.h
--- cspi/spi.h	21 Nov 2002 18:49:38 -0000	1.53
+++ cspi/spi.h	22 Nov 2002 14:38:41 -0000
@@ -801,6 +801,28 @@
 char*        AccessibleTextChangedEvent_getChangeString (const AccessibleEvent *e);
 Accessible * AccessibleChildChangedEvent_getChildAccessible (const AccessibleEvent *e);
 
+Accessible * AccessibleParentChangedEvent_getParentAccessible (const AccessibleEvent *e);
+
+char*        AccessibleTextSelectionChangedEvent_getSelectionString (const AccessibleEvent *e);
+
+char*        AccessibleWindowEvent_getTitleString (const AccessibleEvent *e);
+
+Accessible * AccessibleActiveDescendantChangedEvent_getActiveDescendant (const AccessibleEvent *e);
+
+Accessible * AccessibleTableSummaryChangedEvent_getSummaryAccessible (const AccessibleEvent *e); 
+
+Accessible * AccessibleTableHeaderChangedEvent_getHeaderAccessible (const AccessibleEvent *e);
+
+char *       AccessibleTableCaptionChangedEvent_getCaptionString (const AccessibleEvent *e);
+
+char *       AccessibleTableRowDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
+
+char *       AccessibleTableColumnDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
+
+char *       AccessibleDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
+
+char *       AccessibleNameChangedEvent_getNameString (const AccessibleEvent *e);
+
 /* Misc methods */
 void SPI_freeString (char *s);
 
Index: cspi/spi_event.c
===================================================================
RCS file: /cvs/gnome/at-spi/cspi/spi_event.c,v
retrieving revision 1.24
diff -u -r1.24 spi_event.c
--- cspi/spi_event.c	22 Nov 2002 14:07:55 -0000	1.24
+++ cspi/spi_event.c	22 Nov 2002 14:38:42 -0000
@@ -361,7 +361,6 @@
     return NULL;
 }
 
-
 /**
  * AccessibleTextChangedEvent_getChangeString:
  * @event: a pointer to the #AccessibleEvent being queried.
@@ -381,6 +380,41 @@
 }
 
 /**
+ * AccessibleTextSelectionChangedEvent_getSelectionString:
+ * @event: a pointer to the #AccessibleEvent being queried.
+ *
+ * Queries an #AccessibleEvent of type "object:text-selection-changed", 
+ *         returning the newly added, removed, or modified selection string.
+ *
+ * Returns: a UTF-8 text string indicating the recently changed selection.
+ **/
+char *
+AccessibleTextSelectionChangedEvent_getSelectionString (const AccessibleEvent *e)
+{
+  const InternalEvent *foo = (InternalEvent *) e;
+  /* TODO: check the event type? expensive... */
+  return cspi_internal_event_get_text (foo);
+}
+
+/**
+ * AccessibleWindowEvent_getTitleString:
+ * @event: a pointer to the #AccessibleEvent being queried.
+ *
+ * Queries an #AccessibleEvent of type "window:", 
+ *         returning the window title.
+ *
+ * Returns: a UTF-8 text string representing the title of the 
+ *         recently changed window.
+ **/
+char *
+AccessibleWindowEvent_getTitleString (const AccessibleEvent *e)
+{
+  const InternalEvent *foo = (InternalEvent *) e;
+  /* TODO: check the event type? expensive... */
+  return cspi_internal_event_get_text (foo);
+}
+
+/**
  * AccessibleChildChangedEvent_getChildAccessible:
  * @event: a pointer to the #AccessibleEvent being queried.
  *
@@ -399,5 +433,77 @@
 {
   const InternalEvent *foo = (InternalEvent *) e;
   return (Accessible *) cspi_internal_event_get_object (foo);
+}
+
+/**
+ * AccessibleParentChangedEvent_getParentAccessible:
+ * @event: a pointer to the #AccessibleEvent being queried.
+ *
+ * Queries an #AccessibleEvent of type "object:parent_changed"
+ *         to get a reference to the changed #Accessible.
+ *         Note that context #Accessibles are not guaranteed to outlive
+ *         event delivery, in which case this call may return %NULL
+ *         even if the object existed at the time of dispatch.
+ *
+ * Returns: an #Accessible pointer representing the new parent object.
+ **/
+Accessible *
+AccessibleParentChangedEvent_getParentAccessible (const AccessibleEvent *e)
+{
+  const InternalEvent *foo = (InternalEvent *) e;
+  return (Accessible *) cspi_internal_event_get_object (foo);
+}
+
+/** NEED TO DOCUMENT THESE **/
+
+Accessible *
+AccessibleActiveDescendantChangedEvent_getActiveDescendant (const AccessibleEvent *e) 
+{
+  const InternalEvent *foo = (InternalEvent *) e;
+  return (Accessible *) cspi_internal_event_get_object (foo);
+}
+
+Accessible *
+AccessibleTableSummaryChangedEvent_getSummaryAccessible (const AccessibleEvent *e) 
+{
+  const InternalEvent *foo = (InternalEvent *) e;
+  return (Accessible *) cspi_internal_event_get_object (foo);
+}
+
+Accessible *
+AccessibleTableHeaderChangedEvent_getHeaderAccessible (const AccessibleEvent *e)
+{
+  return NULL;
+}
+
+
+char *
+AccessibleTableCaptionChangedEvent_getCaptionString (const AccessibleEvent *e)
+{
+  return NULL;
+}
+
+char *
+AccessibleTableRowDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e)
+{
+  return NULL;
+}
+
+char *
+AccessibleTableColumnDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e)
+{
+  return NULL;
+}
+
+char *
+AccessibleDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e)
+{
+  return NULL;
+}
+
+char *
+AccessibleNameChangedEvent_getNameString (const AccessibleEvent *e)
+{
+  return NULL;
 }