INTEGRATION: CWS a10y01 (1.2.26); FILE MERGED

2003/05/22 11:19:47 oj 1.2.26.1: #103639# document services

2 files changed, 96 insertions, 7 deletions

diff --git a/offapi/com/sun/star/awt/AccessibleListItem.idl b/offapi/com/sun/star/awt/AccessibleListItem.idl
index 496694fac4a1..b9ad90f65334 100644
--- a/offapi/com/sun/star/awt/AccessibleListItem.idl
+++ b/offapi/com/sun/star/awt/AccessibleListItem.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: AccessibleListItem.idl,v $
  *
- *  $Revision: 1.2 $
+ *  $Revision: 1.3 $
  *
- *  last change: $Author: vg $ $Date: 2003-04-24 17:38:32 $
+ *  last change: $Author: vg $ $Date: 2003-05-27 11:18:43 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -79,15 +79,56 @@ module com { module sun { module star { module awt {
 /** specifies accessibility support for a list item.
 
     @see com::sun::star::accessibility::AccessibleContext
-
+    @see com::sun::star::accessibility::XAccessibleComponent
     @see com::sun::star::accessibility::XAccessibleText
+    @since #103639#
 */
 service AccessibleListItem
 {
+    /** This interface gives access to the structural information of a list item:
+
+       <ul>
+       <li>Role: The role of a list item is <const
+           scope="com::sun::star::accessibility"
+           >AccessibleRole::LIST_ITEM</const>.</li>
+       <li>Name: The name of a list item is the text of the item.</li>
+       <li>Description: The description of a list item is empty.</li>
+       <li>Children: There exists no children.</li>
+       <li>Parent: The parent is of type <type scope"com::sun::star::accessibility">AccessibleList</type>.</li>
+       <li>Relations: There are no relations.</li>
+       <li>States: The states supported by this service are
+           <ul>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::DEFUNC</const>
+               is set if the object has already been disposed
+               and subsequent calls to this object result in
+               <type scope="com::sun::star::lang">DisposedException</type>
+               exceptions.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::ENABLED</const> is always set.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::SHOWING</const> is set
+               if the object is displayed on the screen.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::VISIBLE</const> is always set.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::TRANSIENT</const> is always set.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::SELECTABLE</const> is always set.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::SELECTED</const> is set
+               when the item is selected.</li>
+           </ul>
+           </li>
+       </ul>
+    */
     service   com::sun::star::accessibility::AccessibleContext;
 
     interface com::sun::star::accessibility::XAccessibleComponent;
 
+    /** This interface gives read-only access to the text representation
+        of a list item.
+     */
     interface com::sun::star::accessibility::XAccessibleText;
 };
 
diff --git a/offapi/com/sun/star/awt/AccessibleTextField.idl b/offapi/com/sun/star/awt/AccessibleTextField.idl
index 9cd2beecb507..eabdf1d5e0e1 100644
--- a/offapi/com/sun/star/awt/AccessibleTextField.idl
+++ b/offapi/com/sun/star/awt/AccessibleTextField.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: AccessibleTextField.idl,v $
  *
- *  $Revision: 1.2 $
+ *  $Revision: 1.3 $
  *
- *  last change: $Author: vg $ $Date: 2003-04-24 17:40:55 $
+ *  last change: $Author: vg $ $Date: 2003-05-27 11:19:23 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -79,17 +79,65 @@ module com { module sun { module star { module awt {
 
 
 /** Text fields are like edit fields as described by the
-    <type>AccessibleEdit</type> service but with the ability to edit the
+    <type>AccessibleEdit</type> service but without the ability to edit the
     text.
     @see com::sun::star::accessibility::AccessibleContext
-
     @see com::sun::star::accessibility::XAccessibleComponent
     @see com::sun::star::accessibility::XAccessibleExtendedComponent
+    @see com::sun::star::accessibility::XAccessibleText
+    @since #103639#
 */
 service AccessibleTextField
 {
+    /** This interface gives access to the structural information of a text filed:
+
+       <ul>
+       <li>Role: The role of a text filed is <const
+           scope="com::sun::star::accessibility"
+           >AccessibleRole::TEXT</const>.</li>
+       <li>Name: The name of a text filed is its localized label.</li>
+       <li>Description: The description of a text filed is its localized
+           help text.</li>
+       <li>Children: There exists no children.</li>
+       <li>Parent: The parent is the window that contains the text filed.</li>
+       <li>Relations: There are no relations.</li>
+       <li>States: The states supported by this service are
+           <ul>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::DEFUNC</const>
+               is set if the object has already been disposed
+               and subsequent calls to this object result in
+               <type scope="com::sun::star::lang">DisposedException</type>
+               exceptions.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::ENABLED</const> is set
+               if the object is enabled.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::FOCUSABLE</const> is always set.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::FOCUSED</const> is set
+               if the object currently has the keyboard focus.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::ACTIVE</const> is set
+               if a child has currently the focus.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::RESIZABLE</const> is set
+               if the object can be resized.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::SHOWING</const> is set
+               if the object is displayed on the screen.</li>
+           <li><const scope="com::sun::star::accessibility"
+               >AccessibleStateType::VISIBLE</const> is always set.</li>
+           </ul>
+           </li>
+       </ul>
+    */
+
     service   com::sun::star::accessibility::AccessibleContext;
 
+    /** This interface gives read-only access to the text representation
+        of a text field.
+     */
     interface com::sun::star::accessibility::XAccessibleText;
     interface com::sun::star::accessibility::XAccessibleComponent;
     interface com::sun::star::accessibility::XAccessibleExtendedComponent;