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_AccessibleCheckBox_idl__
25#define __com_sun_star_awt_AccessibleCheckBox_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 check box.
52
53    @since OpenOffice 1.1.2
54 */
55published service AccessibleCheckBox
56{
57    /** This interface gives access to the structural information of a
58        check box:
59
60        <ul>
61        <li>Role: The role of a check box is <const
62            scope="com::sun::star::accessibility"
63            >AccessibleRole::CHECK_BOX</const>.</li>
64        <li>Name: The name of a check box is its localized label.</li>
65        <li>Description: The description of a check box is its localized
66            help text.</li>
67        <li>Children: There are no children.</li>
68        <li>Parent: The parent is the window that contains the check box.</li>
69        <li>Relations: There are no relations.</li>
70        <li>States: The states supported by this service are
71            <ul>
72            <li><const scope="com::sun::star::accessibility"
73                >AccessibleStateType::CHECKED</const> is set
74                if the object is currently checked.</li>
75            <li><const scope="com::sun::star::accessibility"
76                >AccessibleStateType::DEFUNC</const>
77                is set if the object has already been disposed
78                and subsequent calls to this object result in
79                <type scope="com::sun::star::lang">DisposedException</type>
80                exceptions.</li>
81            <li><const scope="com::sun::star::accessibility"
82                >AccessibleStateType::ENABLED</const> is set
83                if the object is enabled.</li>
84            <li><const scope="com::sun::star::accessibility"
85                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
86            <li><const scope="com::sun::star::accessibility"
87                >AccessibleStateType::FOCUSED</const> is set
88                if the object currently has the keyboard focus.</li>
89            <li><const scope="com::sun::star::accessibility"
90                >AccessibleStateType::SHOWING</const> is set
91                if the object is displayed on the screen.</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 read-only access to the text representation
107        of a check box.
108     */
109    interface ::com::sun::star::accessibility::XAccessibleText;
110
111    /** This interface gives access to the actions that can be executed for
112        a check box. The supported actions for a check box are:
113        <ul>
114        <li>click</li>
115        </ul>
116     */
117    interface ::com::sun::star::accessibility::XAccessibleAction;
118
119    /** This interface gives access to the numerical value of a
120        check box, which is related to the check box state:
121
122        <pre>
123        0: not checked
124        1: checked
125        2: don't know
126        </pre>
127     */
128    interface ::com::sun::star::accessibility::XAccessibleValue;
129};
130
131}; }; }; };
132
133#endif
134