1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_awt_AccessibleScrollBar_idl__
29#define __com_sun_star_awt_AccessibleScrollBar_idl__
30
31#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
32#include <com/sun/star/accessibility/XAccessibleContext.idl>
33#endif
34#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
35#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
36#endif
37#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
38#include <com/sun/star/accessibility/XAccessibleComponent.idl>
39#endif
40#ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
41#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
42#endif
43#ifndef __com_sun_star_accessibility_XAccessibleAction_idl__
44#include <com/sun/star/accessibility/XAccessibleAction.idl>
45#endif
46#ifndef __com_sun_star_accessibility_XAccessibleValue_idl__
47#include <com/sun/star/accessibility/XAccessibleValue.idl>
48#endif
49
50module com { module sun { module star { module awt {
51
52/** specifies accessibility support for a scroll bar.
53
54    @since OOo 1.1.2
55 */
56published service AccessibleScrollBar
57{
58    /** This interface gives access to the structural information of a
59        scroll bar:
60
61        <ul>
62        <li>Role: The role of a scroll bar is <const
63            scope="com::sun::star::accessibility"
64            >AccessibleRole::SCROLL_BAR</const>.</li>
65        <li>Name: There is no name.</li>
66        <li>Description: The description of a scroll bar is its localized
67            help text.</li>
68        <li>Children: There are no children.</li>
69        <li>Parent: The parent is the window that contains the scroll bar.</li>
70        <li>Relations: There are no relations.</li>
71        <li>States: The states supported by this service are
72            <ul>
73            <li><const scope="com::sun::star::accessibility"
74                >AccessibleStateType::DEFUNC</const>
75                is set if the object has already been disposed
76                and subsequent calls to this object result in
77                <type scope="com::sun::star::lang">DisposedException</type>
78                exceptions.</li>
79            <li><const scope="com::sun::star::accessibility"
80                >AccessibleStateType::ENABLED</const> is set
81                if the object is enabled.</li>
82            <li><const scope="com::sun::star::accessibility"
83                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
84            <li><const scope="com::sun::star::accessibility"
85                >AccessibleStateType::FOCUSED</const> is set
86                if the object currently has the keyboard focus.</li>
87            <li><const scope="com::sun::star::accessibility"
88                >AccessibleStateType::HORIZONTAL</const> is set
89                if the orientation of the object is horizontal.</li>
90            <li><const scope="com::sun::star::accessibility"
91                >AccessibleStateType::SHOWING</const> is set
92                if the object is displayed on the screen.</li>
93            <li><const scope="com::sun::star::accessibility"
94                >AccessibleStateType::VERTICAL</const> is set
95                if the orientation of the object is vertical.</li>
96            <li><const scope="com::sun::star::accessibility"
97                >AccessibleStateType::VISIBLE</const> is always set.</li>
98            </ul>
99            </li>
100        </ul>
101     */
102    interface ::com::sun::star::accessibility::XAccessibleContext;
103
104    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
105
106    interface ::com::sun::star::accessibility::XAccessibleComponent;
107
108    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
109
110    /** This interface gives access to the actions that can be executed for
111        a scroll bar. The supported actions for a scroll bar are:
112        <ul>
113        <li>decrementLine</li>
114        <li>incrementLine</li>
115        <li>decrementBlock</li>
116        <li>incrementBlock</li>
117        </ul>
118     */
119    interface ::com::sun::star::accessibility::XAccessibleAction;
120
121    /** This interface gives access to the numerical value of a scroll bar,
122        which is related to the position of the scroll bar thumb.
123     */
124    interface ::com::sun::star::accessibility::XAccessibleValue;
125};
126
127}; }; }; };
128
129#endif
130