1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_awt_AccessibleScrollBar_idl__
25#define __com_sun_star_awt_AccessibleScrollBar_idl__
26
27#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
28#include <com/sun/star/accessibility/XAccessibleContext.idl>
29#endif
30#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
31#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
32#endif
33#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
34#include <com/sun/star/accessibility/XAccessibleComponent.idl>
35#endif
36#ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
37#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
38#endif
39#ifndef __com_sun_star_accessibility_XAccessibleAction_idl__
40#include <com/sun/star/accessibility/XAccessibleAction.idl>
41#endif
42#ifndef __com_sun_star_accessibility_XAccessibleValue_idl__
43#include <com/sun/star/accessibility/XAccessibleValue.idl>
44#endif
45
46module com { module sun { module star { module awt {
47
48/** specifies accessibility support for a scroll bar.
49
50    @since OOo 1.1.2
51 */
52published service AccessibleScrollBar
53{
54    /** This interface gives access to the structural information of a
55        scroll bar:
56
57        <ul>
58        <li>Role: The role of a scroll bar is <const
59            scope="com::sun::star::accessibility"
60            >AccessibleRole::SCROLL_BAR</const>.</li>
61        <li>Name: There is no name.</li>
62        <li>Description: The description of a scroll bar is its localized
63            help text.</li>
64        <li>Children: There are no children.</li>
65        <li>Parent: The parent is the window that contains the scroll bar.</li>
66        <li>Relations: There are no relations.</li>
67        <li>States: The states supported by this service are
68            <ul>
69            <li><const scope="com::sun::star::accessibility"
70                >AccessibleStateType::DEFUNC</const>
71                is set if the object has already been disposed
72                and subsequent calls to this object result in
73                <type scope="com::sun::star::lang">DisposedException</type>
74                exceptions.</li>
75            <li><const scope="com::sun::star::accessibility"
76                >AccessibleStateType::ENABLED</const> is set
77                if the object is enabled.</li>
78            <li><const scope="com::sun::star::accessibility"
79                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
80            <li><const scope="com::sun::star::accessibility"
81                >AccessibleStateType::FOCUSED</const> is set
82                if the object currently has the keyboard focus.</li>
83            <li><const scope="com::sun::star::accessibility"
84                >AccessibleStateType::HORIZONTAL</const> is set
85                if the orientation of the object is horizontal.</li>
86            <li><const scope="com::sun::star::accessibility"
87                >AccessibleStateType::SHOWING</const> is set
88                if the object is displayed on the screen.</li>
89            <li><const scope="com::sun::star::accessibility"
90                >AccessibleStateType::VERTICAL</const> is set
91                if the orientation of the object is vertical.</li>
92            <li><const scope="com::sun::star::accessibility"
93                >AccessibleStateType::VISIBLE</const> is always set.</li>
94            </ul>
95            </li>
96        </ul>
97     */
98    interface ::com::sun::star::accessibility::XAccessibleContext;
99
100    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
101
102    interface ::com::sun::star::accessibility::XAccessibleComponent;
103
104    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
105
106    /** This interface gives access to the actions that can be executed for
107        a scroll bar. The supported actions for a scroll bar are:
108        <ul>
109        <li>decrementLine</li>
110        <li>incrementLine</li>
111        <li>decrementBlock</li>
112        <li>incrementBlock</li>
113        </ul>
114     */
115    interface ::com::sun::star::accessibility::XAccessibleAction;
116
117    /** This interface gives access to the numerical value of a scroll bar,
118        which is related to the position of the scroll bar thumb.
119     */
120    interface ::com::sun::star::accessibility::XAccessibleValue;
121};
122
123}; }; }; };
124
125#endif
126