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