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_AccessibleRadioButton_idl__
25#define __com_sun_star_awt_AccessibleRadioButton_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 radio button.
52
53    @since OpenOffice 1.1.2
54 */
55published service AccessibleRadioButton
56{
57    /** This interface gives access to the structural information of a
58        radio button:
59
60        <ul>
61        <li>Role: The role of a radio button is <const
62            scope="com::sun::star::accessibility"
63            >AccessibleRole::RADIO_BUTTON</const>.</li>
64        <li>Name: The name of a radio button is its localized label.</li>
65        <li>Description: The description of a radio button 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 radio button.</li>
69        <li>Relations: The relations supported by this service are
70            <ul>
71            <li><const scope="com::sun::star::accessibility"
72                >AccessibleRelationType::MEMBER_OF</const> is set
73                if the object is a member of a group of one or more
74                target objects.</li>
75            </ul>
76            </li>
77        <li>States: The states supported by this service are
78            <ul>
79            <li><const scope="com::sun::star::accessibility"
80                >AccessibleStateType::CHECKED</const> is set
81                if the object is currently checked.</li>
82            <li><const scope="com::sun::star::accessibility"
83                >AccessibleStateType::DEFUNC</const>
84                is set if the object has already been disposed
85                and subsequent calls to this object result in
86                <type scope="com::sun::star::lang">DisposedException</type>
87                exceptions.</li>
88            <li><const scope="com::sun::star::accessibility"
89                >AccessibleStateType::ENABLED</const> is set
90                if the object is enabled.</li>
91            <li><const scope="com::sun::star::accessibility"
92                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
93            <li><const scope="com::sun::star::accessibility"
94                >AccessibleStateType::FOCUSED</const> is set
95                if the object currently has the keyboard focus.</li>
96            <li><const scope="com::sun::star::accessibility"
97                >AccessibleStateType::SHOWING</const> is set
98                if the object is displayed on the screen.</li>
99            <li><const scope="com::sun::star::accessibility"
100                >AccessibleStateType::VISIBLE</const> is always set.</li>
101            </ul>
102            </li>
103        </ul>
104     */
105    interface ::com::sun::star::accessibility::XAccessibleContext;
106
107    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
108
109    interface ::com::sun::star::accessibility::XAccessibleComponent;
110
111    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
112
113    /** This interface gives read-only access to the text representation
114        of a radio button.
115     */
116    interface ::com::sun::star::accessibility::XAccessibleText;
117
118    /** This interface gives access to the actions that can be executed for
119        a radio button. The supported actions for a radio button are:
120        <ul>
121        <li>click</li>
122        </ul>
123     */
124    interface ::com::sun::star::accessibility::XAccessibleAction;
125
126    /** This interface gives access to the numerical value of a
127        radio button, which is related to the radio button's
128        <const scope="com::sun::star::accessibility"
129        >AccessibleStateType::CHECKED</const> state.
130     */
131    interface ::com::sun::star::accessibility::XAccessibleValue;
132
133};
134
135}; }; }; };
136
137#endif
138