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