Doc fixes, and a (minor) API fix to AccessibleStreamableContent_seek.

Incremented version to 0.12.

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

diff --git a/ChangeLog b/ChangeLog
index e919d5f0ddba8d9470fc26c844ca4c9508479542..a16e5f348775bd170b91355cf2da7e7b8dcf4602 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,29 @@
+2002-04-16  Bill Haneman <bill.haneman@sun.com>
+
+       * configure.in:
+       Revved version to 0.12 due to API change (see below).
+
+       * cspi/spi-roletypes.h:
+       removed (obsolete) SPI_ROLE_FOCUS_TRAVERSABLE 
+       definition from the inline docs, and added docs
+       for SPI_ROLE_LAST_DEFINED.
+
+       * cspi/spi.h:
+       * cspi/spi_streamablecontent.c:
+       Added missing seek_type parameter to
+       (so far unused) method, 
+       AccessibleStreamableContent_seek().
+       [ RT approval JodyG. ]
+
+       * cspi/spi_event.c:
+       Fixed docs for SPI_createAccessibleKeystrokeListener.
+
+       * cspi/spi_registry.c:
+       Fixed docs for SPI_KEYSET_ALL_KEYS.
+       
+       * docs/reference/cspi/at-spi-cspi-sections.txt:
+       Added a number of missing APIs to SECTIONS.
+       
 2002-04-16  Bill Haneman <bill.haneman@sun.com>
 
        * registryd/Makefile.am:

diff --git a/configure.in b/configure.in
index 0236f300fc042012611271977cf5280a584a0520..d946defd86fd0a46820f7ec7a696fe052f5ffc80 100644 (file)
--- a/configure.in
+++ b/configure.in
@@ -1,7 +1,7 @@
 AC_INIT(idl/Accessibility.idl)
 
 AT_SPI_MAJOR_VERSION=0
-AT_SPI_MINOR_VERSION=11
+AT_SPI_MINOR_VERSION=12
 AT_SPI_MICRO_VERSION=0
 AT_SPI_INTERFACE_AGE=0
 AT_SPI_BINARY_AGE=0

diff --git a/cspi/spi-roletypes.h b/cspi/spi-roletypes.h
index a2818952d6e7f959567511fecf039713e0b5df78..8cae974623cbd6ae70fea97731394dae81ecb29c 100644 (file)
--- a/cspi/spi-roletypes.h
+++ b/cspi/spi-roletypes.h
@@ -35,7 +35,6 @@ extern "C" {
  *               directory and lets the user select a file, browse a different
  *              directory, or specify a filename.
  * @SPI_ROLE_FILLER: A object that fills up space in a user interface
- * @SPI_ROLE_FOCUS_TRAVERSABLE: XXX Not sure about this.
  * @SPI_ROLE_FONT_CHOOSER: Allows selection of a display font
  * @SPI_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
  * @SPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all
@@ -109,6 +108,7 @@ extern "C" {
  * @SPI_ROLE_WINDOW: A top level window with no title or border.
  * @SPI_ROLE_EXTENDED: This object's role is not included in the standard role list and
  *                     should be queried by name.
+ * @SPI_ROLE_LAST_DEFINED: Used to determine the end of the role enumeration.
  **/
 typedef enum
 {

diff --git a/cspi/spi.h b/cspi/spi.h
index 5deb7449ce7a39d55335c3ceccca6406341a4c77..2c487cc142a183bc8a010b7b110b1ca833fc2b47 100644 (file)
--- a/cspi/spi.h
+++ b/cspi/spi.h
@@ -533,7 +533,8 @@ AccessibleStreamableContent_open (AccessibleStreamableContent *obj,
                                  const char *content_type);
 SPIBoolean
 AccessibleStreamableContent_seek (AccessibleStreamableContent *obj,
-                                 long int offset);
+                                 long int offset,
+                                 unsigned int seek_type);
 SPIBoolean
 AccessibleStreamableContent_read (AccessibleStreamableContent *obj,
                                  void *buff,

diff --git a/cspi/spi_event.c b/cspi/spi_event.c
index 469dedc377b6f2099245d20a5fca4ee331ae704f..33c469adc014e12af545898a8f0b03153209f675 100644 (file)
--- a/cspi/spi_event.c
+++ b/cspi/spi_event.c
@@ -184,7 +184,7 @@ AccessibleEventListener_removeCallback (AccessibleEventListener  *listener,
 }
 
 /**
- * createAccessibleKeystrokeListener:
+ * SPI_createAccessibleKeystrokeListener:
  * @callback : an #AccessibleKeystrokeListenerCB callback function, or NULL.
  * @user_data: a pointer to data which will be passed to the callback when invoked.
  *

diff --git a/cspi/spi_registry.c b/cspi/spi_registry.c
index cc0dca29fb3266105ee76e8ef2a386712081e5f5..cea5cf6535931b5e439bed894754ba7776799685 100644 (file)
--- a/cspi/spi_registry.c
+++ b/cspi/spi_registry.c
@@ -285,6 +285,12 @@ SPI_freeDesktopList (Accessible **desktop_list)
   g_free (desktop_list);
 }
 
+/**
+ * SPI_KEYSET_ALL_KEYS:
+ * @SPI_KEYSET_ALL_KEYS: A special value for an AccessibleKeySet type, which tacitly
+ *                       includes all keycodes and keyvals for the specified modifier set.
+ **/
+
 /**
  * SPI_registerAccessibleKeystrokeListener:
  * @listener:  a pointer to the #AccessibleKeystrokeListener for which

diff --git a/cspi/spi_streamablecontent.c b/cspi/spi_streamablecontent.c
index 5fe36a522a044bcc269b2e1bda0731a5ccf9913d..9a2db99146adc6bc4568d154f3bf1995d385851d 100644 (file)
--- a/cspi/spi_streamablecontent.c
+++ b/cspi/spi_streamablecontent.c
@@ -54,9 +54,6 @@ AccessibleStreamableContent_getContentTypes (AccessibleStreamableContent *obj)
  * @obj: a pointer to the #AccessibleStreamableContent implementor on which to operate.
  * @content_type: a string specifying the content type to retrieve (should match one
  * of the return strings from #AccessibleStreamableContent_getContentTypes ()).
- * @fp: a pointer to a FILE pointer into which is placed a file handle suitable for
- *      reading the content, if possible.  Not all content types support file-handle
- *      interaction, so check this parameter for NULL before use.
  *
  * Open a streaming connection to an AccessibleStreamableContent implementor,
  *       of a particular content type
@@ -88,7 +85,8 @@ AccessibleStreamableContent_open (AccessibleStreamableContent *obj,
  **/
 SPIBoolean
 AccessibleStreamableContent_seek (AccessibleStreamableContent *obj,
-                                 long int offset)
+                                 long int offset,
+                                 unsigned int seek_type)
 {
   /* TODO: connect this to the correct libspi implementation code */
   return FALSE;

diff --git a/docs/reference/cspi/at-spi-cspi-sections.txt b/docs/reference/cspi/at-spi-cspi-sections.txt
index 6ce8cd56beaf22eda606d2bb3b5c11203e50cacc..576c03e77ce0c182ec4fe24fd1de34cc5bad163d 100644 (file)
--- a/docs/reference/cspi/at-spi-cspi-sections.txt
+++ b/docs/reference/cspi/at-spi-cspi-sections.txt
@@ -29,6 +29,7 @@ AccessibleKeySynthType
 SPI_getDesktopCount
 SPI_getDesktop
 SPI_getDesktopList
+SPI_freeDesktopList
 <SUBSECTION Event Registration>
 AccessibleKeystrokeListenerCB
 AccessibleKeyEventMask
@@ -36,13 +37,15 @@ AccessibleKeyMaskType
 AccessibleKeyEventType
 AccessibleKeyListenerSyncType
 AccessibleKeystroke
+SPI_KEYSET_ALL_KEYS
+SPI_createAccessibleKeySet
+SPI_freeAccessibleKeySet
 SPI_createAccessibleKeystrokeListener
 SPI_registerGlobalEventListener
 SPI_deregisterGlobalEventListener
 SPI_deregisterGlobalEventListenerAll
 SPI_registerAccessibleKeystrokeListener
 SPI_deregisterAccessibleKeystrokeListener
-AccessibleKeystrokeListener_ref
 AccessibleKeystrokeListener_unref
 AccessibleKeystrokeListener_removeCallback
 AccessibleKeystrokeListener_addCallback
@@ -53,6 +56,7 @@ SPI_generateMouseEvent
 <SECTION>
 <FILE>spi_accessible</FILE>
 <TITLE>Accessible Objects</TITLE>
+Accessible
 Accessible_ref
 Accessible_unref
 Accessible_getName
@@ -73,6 +77,7 @@ Accessible_isEditableText
 Accessible_isHypertext
 Accessible_isImage
 Accessible_isSelection
+Accessible_isStreamableContent
 Accessible_isTable
 Accessible_isText
 Accessible_isValue
@@ -83,6 +88,7 @@ Accessible_getEditableText
 Accessible_getHypertext
 Accessible_getImage
 Accessible_getSelection
+Accessible_getStreamableContent
 Accessible_getTable
 Accessible_getText
 Accessible_getValue
@@ -182,6 +188,17 @@ AccessibleSelection_clearSelection
 AccessibleSelection_selectAll
 </SECTION>
 
+<SECTION>
+<FILE>spi_streamable_content</FILE>
+<TITLE>AccessibleStreamableContent Interface</TITLE>
+AccessibleStreamableContent_ref
+AccessibleStreamableContent_unref
+AccessibleStreamableContent_getContentTypes
+AccessibleStreamableContent_open
+AccessibleStreamableContent_seek
+AccessibleStreamableContent_read
+</SECTION>
+
 <SECTION>
 <FILE>spi_table</FILE>
 <TITLE>AccessibleTable Interface</TITLE>

diff --git a/docs/reference/cspi/tmpl/spi_accessible.sgml b/docs/reference/cspi/tmpl/spi_accessible.sgml
index 9b7b374187803db597c0eeb6285d2a97547f3356..da975e7cdd98fb33f652e0fdc8c0fbb31a217ff3 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_accessible.sgml
+++ b/docs/reference/cspi/tmpl/spi_accessible.sgml
@@ -14,6 +14,14 @@ Accessible Objects
 
 </para>
 
+<!-- ##### STRUCT Accessible ##### -->
+<para>
+
+</para>
+
+@objref: 
+@ref_count: 
+
 <!-- ##### FUNCTION Accessible_ref ##### -->
 <para>
 
@@ -188,6 +196,15 @@ Accessible Objects
 @Returns: 
 
 
+<!-- ##### FUNCTION Accessible_isStreamableContent ##### -->
+<para>
+
+</para>
+
+@obj: 
+@Returns: 
+
+
 <!-- ##### FUNCTION Accessible_isTable ##### -->
 <para>
 
@@ -278,6 +295,15 @@ Accessible Objects
 @Returns: 
 
 
+<!-- ##### FUNCTION Accessible_getStreamableContent ##### -->
+<para>
+
+</para>
+
+@obj: 
+@Returns: 
+
+
 <!-- ##### FUNCTION Accessible_getTable ##### -->
 <para>
 

diff --git a/docs/reference/cspi/tmpl/spi_registry.sgml b/docs/reference/cspi/tmpl/spi_registry.sgml
index 09ab7cd63a8daa884d7803ed710db84d4f7c0ea3..23adfde7f63d826ddddbdc13ba8a514d14c6659d 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_registry.sgml
+++ b/docs/reference/cspi/tmpl/spi_registry.sgml
@@ -53,6 +53,14 @@ Registry queries
 @list: 
 
 
+<!-- ##### FUNCTION SPI_freeDesktopList ##### -->
+<para>
+
+</para>
+
+@desktop_list: 
+
+
 <!-- ##### USER_FUNCTION AccessibleKeystrokeListenerCB ##### -->
 <para>
 
@@ -99,6 +107,33 @@ Registry queries
 </para>
 
 
+<!-- ##### MACRO SPI_KEYSET_ALL_KEYS ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION SPI_createAccessibleKeySet ##### -->
+<para>
+
+</para>
+
+@len: 
+@keysyms: 
+@keycodes: 
+@keystrings: 
+@Returns: 
+
+
+<!-- ##### FUNCTION SPI_freeAccessibleKeySet ##### -->
+<para>
+
+</para>
+
+@keyset: 
+
+
 <!-- ##### FUNCTION SPI_createAccessibleKeystrokeListener ##### -->
 <para>