Documentation fixes for event listener APIs which now include user_data

parameters to callbacks.
Changed stateset compare API to return a difference set rather that
return the difference values into a StateSet pointer.

git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@155 e2bd861d-eb25-0410-b326-f6ed22b6b98c

diff --git a/ChangeLog b/ChangeLog
index fc7a5f2..960ead7 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,9 +1,25 @@
 2001-12-09  Bill Haneman <bill.haneman@sun.com>
 
+       * cspi/spi.h:
+       * cspi/spi_event.c:
+       * cspi/spi_accessible.c:
+       Documentation fixes: added user_data params to documentation for 
+       listeners and callbacks.  
+
+       * cspi/spi_accessible.c: 
+       Changed AccessibleStateSet_compare to return a
+       StateSet rather than return the difference set into a third parameter.
+       
+       
+2001-12-09  Bill Haneman <bill.haneman@sun.com>
+
        * configure.in:
        Replace use of AM_PROG_XML_I18N_TOOLS macro with AC_PROG_INTLTOOL.
        remove 'dnl' comment line from AC_OUTPUT (autoconf doesn't like
-       it).
+       it). 
+
+       * Makefile.am:
+       Remove subdirectory po from SUBDIRS for now.
 
        * at-bridge/bridge.c:
        Beefed up a couple of debug printouts.

diff --git a/cspi/spi.h b/cspi/spi.h
index a0ca6c8..0842a3a 100644 (file)
--- a/cspi/spi.h
+++ b/cspi/spi.h
@@ -685,10 +685,9 @@ SPIBoolean
 AccessibleStateSet_equals (AccessibleStateSet *obj,
                            AccessibleStateSet *obj2);
 
-void
+AccessibleStateSet *
 AccessibleStateSet_compare (AccessibleStateSet *obj,
-                            AccessibleStateSet *obj2,
-                            AccessibleStateSet **differenceSet);
+                            AccessibleStateSet *obj2);
 
 SPIBoolean
 AccessibleStateSet_isEmpty (AccessibleStateSet *obj);

diff --git a/cspi/spi_accessible.c b/cspi/spi_accessible.c
index 973af99..a321b54 100644 (file)
--- a/cspi/spi_accessible.c
+++ b/cspi/spi_accessible.c
@@ -885,11 +885,9 @@ AccessibleStateSet_equals (AccessibleStateSet *obj,
  * AccessibleStateSet_compare:
  * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
  * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
- * @differenceSet: a pointer to an array of #AccessibleStates, which is set when the
- *        fuction returns to point to an array of states representing the states which
- *        the two state sets do not have in common.
  *
  * Determine the differences between two instances of #AccessibleStateSet.
+ * Not Yet Implemented.
  *.
  * @see AccessibleStateSet_equals().
  *
@@ -897,11 +895,12 @@ AccessibleStateSet_equals (AccessibleStateSet *obj,
  *          the two sets but not the other.
  *
  **/
-void
+AccessibleStateSet *
 AccessibleStateSet_compare (AccessibleStateSet *obj,
-                            AccessibleStateSet *obj2,
-                            AccessibleStateSet **differenceSet);
-
+                            AccessibleStateSet *obj2)
+{
+  return NULL; 
+}
 
 /**
  * AccessibleStateSet_isEmpty:

diff --git a/cspi/spi_event.c b/cspi/spi_event.c
index 7fbe0ee..7574c93 100644 (file)
--- a/cspi/spi_event.c
+++ b/cspi/spi_event.c
@@ -26,6 +26,7 @@
 /**
  * createAccessibleEventListener:
  * @callback : an #AccessibleEventListenerCB callback function, or NULL.
+ * @user_data: a pointer to data which will be passed to the callback when invoked.
  *
  * Create a new #AccessibleEventListener with a specified (in-process) callback function.
  *
@@ -48,6 +49,7 @@ createAccessibleEventListener (AccessibleEventListenerCB callback,
  * AccessibleEventListener_addCallback:
  * @listener: the #AccessibleEventListener instance to modify.
  * @callback: an #AccessibleEventListenerCB function pointer.
+ * @user_data: a pointer to data which will be passed to the callback when invoked.
  *
  * Add an in-process callback function to an existing AccessibleEventListener.
  * Note that the callback function must live in the same address
@@ -102,6 +104,7 @@ AccessibleEventListener_removeCallback (AccessibleEventListener  *listener,
 /**
  * createAccessibleKeystrokeListener:
  * @callback : an #AccessibleKeystrokeListenerCB callback function, or NULL.
+ * @user_data: a pointer to data which will be passed to the callback when invoked.
  *
  * Create a new #AccessibleKeystrokeListener with a specified callback function.
  *
@@ -124,6 +127,7 @@ createAccessibleKeystrokeListener (AccessibleKeystrokeListenerCB callback,
  * AccessibleKeystrokeListener_addCallback:
  * @listener: the #AccessibleKeystrokeListener instance to modify.
  * @callback: an #AccessibleKeystrokeListenerCB function pointer.
+ * @user_data: a pointer to data which will be passed to the callback when invoked.
  *
  * Add an in-process callback function to an existing #AccessibleKeystrokeListener.
  *

diff --git a/cspi/spi_image.c b/cspi/spi_image.c
index c351ecf..7b4d6a4 100644 (file)
--- a/cspi/spi_image.c
+++ b/cspi/spi_image.c
@@ -102,7 +102,7 @@ AccessibleImage_getImagePosition (AccessibleImage *obj,
  * @x: a pointer to a #long into which the minimum x coordinate will be returned.
  * @y: a pointer to a #long into which the minimum y coordinate will be returned.
  * @width: a pointer to a #long into which the image x extent will be returned.
- * @width: a pointer to a #long into which the image y extent will be returned.
+ * @height: a pointer to a #long into which the image y extent will be returned.
  * @ctype: the desired coordinate system into which to return the results,
  *         (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
  *

diff --git a/docs/reference/cspi/tmpl/spi_main.sgml b/docs/reference/cspi/tmpl/spi_main.sgml
index 81f28de..60dadac 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_main.sgml
+++ b/docs/reference/cspi/tmpl/spi_main.sgml
@@ -19,8 +19,9 @@ SPI main loop and initialization
 
 </para>
 
-@isGNOMEApp: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@isGNOMEApp: 
 
 
 <!-- ##### FUNCTION SPI_event_main ##### -->
@@ -54,6 +55,7 @@ SPI main loop and initialization
 
 </para>
 
+@Returns: 
 
 
 <!-- ##### FUNCTION SPI_freeString ##### -->

diff --git a/docs/reference/cspi/tmpl/spi_stateset.sgml b/docs/reference/cspi/tmpl/spi_stateset.sgml
index 6558f53..8d95b27 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_stateset.sgml
+++ b/docs/reference/cspi/tmpl/spi_stateset.sgml
@@ -82,6 +82,8 @@ State and StateSets
 
 @obj: 
 @obj2: 
+@Returns: 
+<!-- # Unused Parameters # -->
 @differenceSet: