summaryrefslogtreecommitdiff
path: root/idl
diff options
context:
space:
mode:
authorbillh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c>2006-12-04 15:36:59 +0000
committerbillh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c>2006-12-04 15:36:59 +0000
commitb5314fe01a7e3dd4663738f48f29d58e8137a092 (patch)
tree838b08750b5e7cbdc5449076c3c82781a64a31fe /idl
parent59568fcca2ea754f1ebb7133f29e1e0908e2af4a (diff)
downloadat-spi2-core-b5314fe01a7e3dd4663738f48f29d58e8137a092.tar.gz
Documentation fix for ROLE_FORM.
git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@866 e2bd861d-eb25-0410-b326-f6ed22b6b98c
Diffstat (limited to 'idl')
-rw-r--r--idl/Accessibility_Role.idl15
1 files changed, 11 insertions, 4 deletions
diff --git a/idl/Accessibility_Role.idl b/idl/Accessibility_Role.idl
index 38b7160a..fc962c64 100644
--- 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
*/