INTEGRATION: CWS uno4 (1.2.4); FILE MERGED

2003/05/05 15:49:51 tbe 1.2.4.1: #109171# Document accessibility service descriptions in ::com::sun::star::awt

1 files changed, 65 insertions, 2 deletions

diff --git a/offapi/com/sun/star/awt/AccessibleScrollBar.idl b/offapi/com/sun/star/awt/AccessibleScrollBar.idl
index fa52636b407f..ebbb3f0e72bf 100644
--- a/offapi/com/sun/star/awt/AccessibleScrollBar.idl
+++ b/offapi/com/sun/star/awt/AccessibleScrollBar.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: AccessibleScrollBar.idl,v $
  *
- *  $Revision: 1.2 $
+ *  $Revision: 1.3 $
  *
- *  last change: $Author: vg $ $Date: 2003-04-24 17:39:34 $
+ *  last change: $Author: vg $ $Date: 2003-05-22 09:28:59 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -84,14 +84,77 @@
 module com { module sun { module star { module awt {
 
 /** specifies accessibility support for a scroll bar.
+
+    @since #108645#
  */
 service AccessibleScrollBar
 {
+    /** This interface gives access to the structural information of a
+        scroll bar:
+
+        <ul>
+        <li>Role: The role of a scroll bar is <const
+            scope="com::sun::star::accessibility"
+            >AccessibleRole::SCROLL_BAR</const>.</li>
+        <li>Name: There is no name.</li>
+        <li>Description: The description of a scroll bar is its localized
+            help text.</li>
+        <li>Children: There are no children.</li>
+        <li>Parent: The parent is the window that contains the scroll bar.</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::HORIZONTAL</const> is set
+                if the orientation of the object is horizontal.</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::VERTICAL</const> is set
+                if the orientation of the object is vertical.</li>
+            <li><const scope="com::sun::star::accessibility"
+                >AccessibleStateType::VISIBLE</const> is always set.</li>
+            </ul>
+            </li>
+        </ul>
+     */
     interface ::com::sun::star::accessibility::XAccessibleContext;
+
     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
+
     interface ::com::sun::star::accessibility::XAccessibleComponent;
+
     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
+
+    /** This interface gives access to the actions that can be executed for
+        a scroll bar. The supported actions for a scroll bar are:
+        <ul>
+        <li>decrementLine</li>
+        <li>incrementLine</li>
+        <li>decrementBlock</li>
+        <li>incrementBlock</li>
+        </ul>
+     */
     interface ::com::sun::star::accessibility::XAccessibleAction;
+
+    /** This interface gives access to the numerical value of a scroll bar,
+        which is related to the position of the scroll bar thumb.
+     */
     interface ::com::sun::star::accessibility::XAccessibleValue;
 };