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_AccessibleButton_idl__
25#define __com_sun_star_awt_AccessibleButton_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_XAccessibleText_idl__
40#include <com/sun/star/accessibility/XAccessibleText.idl>
41#endif
42#ifndef __com_sun_star_accessibility_XAccessibleAction_idl__
43#include <com/sun/star/accessibility/XAccessibleAction.idl>
44#endif
45#ifndef __com_sun_star_accessibility_XAccessibleValue_idl__
46#include <com/sun/star/accessibility/XAccessibleValue.idl>
47#endif
48
49module com { module sun { module star { module awt {
50
51/** specifies accessibility support for a button.
52
53    @since OpenOffice 1.1.2
54 */
55published service AccessibleButton
56{
57    /** This interface gives access to the structural information of a button:
58
59        <ul>
60        <li>Role: The role of a button is <const
61            scope="com::sun::star::accessibility"
62            >AccessibleRole::PUSH_BUTTON</const>.</li>
63        <li>Name: The name of a button is its localized label.</li>
64        <li>Description: The description of a button is its localized
65            help text.</li>
66        <li>Children: There are no children.</li>
67        <li>Parent: The parent is the window that contains the button.</li>
68        <li>Relations: There are no relations.</li>
69        <li>States: The states supported by this service are
70            <ul>
71            <li><const scope="com::sun::star::accessibility"
72                >AccessibleStateType::CHECKED</const> is set
73                if the object is currently checked.</li>
74            <li><const scope="com::sun::star::accessibility"
75                >AccessibleStateType::DEFUNC</const>
76                is set if the object has already been disposed
77                and subsequent calls to this object result in
78                <type scope="com::sun::star::lang">DisposedException</type>
79                exceptions.</li>
80            <li><const scope="com::sun::star::accessibility"
81                >AccessibleStateType::ENABLED</const> is set
82                if the object is enabled.</li>
83            <li><const scope="com::sun::star::accessibility"
84                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
85            <li><const scope="com::sun::star::accessibility"
86                >AccessibleStateType::FOCUSED</const> is set
87                if the object currently has the keyboard focus.</li>
88            <li><const scope="com::sun::star::accessibility"
89                >AccessibleStateType::PRESSED</const> is set
90                if the object is currently pressed.</li>
91            <li><const scope="com::sun::star::accessibility"
92                >AccessibleStateType::SHOWING</const> is set
93                if the object is displayed on the screen.</li>
94            <li><const scope="com::sun::star::accessibility"
95                >AccessibleStateType::VISIBLE</const> is always set.</li>
96            </ul>
97            </li>
98        </ul>
99     */
100    interface ::com::sun::star::accessibility::XAccessibleContext;
101
102    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
103
104    interface ::com::sun::star::accessibility::XAccessibleComponent;
105
106    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
107
108    /** This interface gives read-only access to the text representation
109        of a button.
110     */
111    interface ::com::sun::star::accessibility::XAccessibleText;
112
113    /** This interface gives access to the actions that can be executed for
114        a button. The supported actions for a button are:
115        <ul>
116        <li>click</li>
117        </ul>
118     */
119    interface ::com::sun::star::accessibility::XAccessibleAction;
120
121    /** This interface gives access to the numerical value of a button,
122        which is related to the button's
123        <const scope="com::sun::star::accessibility"
124        >AccessibleStateType::PRESSED</const> state.
125     */
126    interface ::com::sun::star::accessibility::XAccessibleValue;
127
128};
129
130}; }; }; };
131
132#endif
133