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