Documentation fix for ROLE_FORM.

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

diff --git a/ChangeLog b/ChangeLog
index d2ddc33fe5d238f2fdafe8c734551b4b0db51dcb..e0d8b6ddefba5b3f8db2dd477f488ba756f7863e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-12-04  Bill Haneman <bill.haneman@sun.com>
+
+       * idl/Accessibility_Role.idl: Fixed the documentation for
+       ROLE_FORM; bug #382271.  Thanks to George Kraft for finding this.
+       
 2006-12-04  Bill Haneman <bill.haneman@sun.com>
        
        * Added Li Yuan <li.yuan@sun.com> to MAINTAINERS.

diff --git a/idl/Accessibility_Role.idl b/idl/Accessibility_Role.idl
index 38b7160a59e6acc31f1323e745ad01d4f5ef85c2..fc962c648b78c3f2e3c844aa5770ee124148740b 100644 (file)
--- a/idl/Accessibility_Role.idl
+++ b/idl/Accessibility_Role.idl
@@ -366,10 +366,17 @@ module Accessibility {
    */
   ROLE_REDUNDANT_OBJECT,
   /**
-   * The object is a containing instance of document content which constitutes
-   * a particular 'logical' section of the document.  The type of content within
-   * a section, and the nature of the section division itself, may be obtained
-   * by querying the object's attributes.  Sections may be nested.
+   * The object is a containing instance of document content which
+   * has within it components with which the user can interact in order to
+   * input information; i.e. the object is a container for pushbuttons,
+   * comboboxes, text input fields, and other 'GUI' components.
+   * ROLE_FORM should not, in general, be used for toplevel GUI containers
+   * or dialogs, but should be reserved for 'GUI' containers which occur within
+   * document content, for instance within Web documents, presentations, or 
+   * text documents.  Unlike other GUI containers and dialogs which occur inside
+   * application instances, ROLE_FORM containers' components are associated with
+   * the current document, rather than the current foreground application or
+   * viewer instance.
    *
    * @since AT-SPI 1.7.6
    */