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_AccessibleWindow_idl__
29#define __com_sun_star_awt_AccessibleWindow_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
44module com { module sun { module star { module awt {
45
46/** specifies accessibility support for a window.
47
48    @since OOo 1.1.2
49 */
50published service AccessibleWindow
51{
52    /** This interface gives access to the structural information of a window:
53
54        <ul>
55        <li>Role: The role of a window is not fixed. A window may have
56            one of the following roles:
57            <ul>
58            <li><const scope="com::sun::star::accessibility"
59                >AccessibleRole::DIALOG</const></li>
60            <li><const scope="com::sun::star::accessibility"
61                >AccessibleRole::FRAME</const></li>
62            <li><const scope="com::sun::star::accessibility"
63                >AccessibleRole::LAYERED_PANE</const></li>
64            <li><const scope="com::sun::star::accessibility"
65                >AccessibleRole::PANEL</const></li>
66            <li><const scope="com::sun::star::accessibility"
67                >AccessibleRole::ROOT_PANE</const></li>
68            <li><const scope="com::sun::star::accessibility"
69                >AccessibleRole::SCROLL_PANE</const></li>
70            <li><const scope="com::sun::star::accessibility"
71                >AccessibleRole::SPLIT_PANE</const></li>
72            <li><const scope="com::sun::star::accessibility"
73                >AccessibleRole::WINDOW</const></li>
74            <li>...</li>
75            </ul>
76            </li>
77        <li>Name: The name of a window is its localized title.</li>
78        <li>Description: The description of a window is its localized
79            help text.</li>
80        <li>Children: The children of a window are the child windows.</li>
81        <li>Parent: The parent of a window is the parent window.</li>
82        <li>Relations: There are no relations.</li>
83        <li>States: The states supported by this service are
84            <ul>
85            <li><const scope="com::sun::star::accessibility"
86                >AccessibleStateType::ACTIVE</const> is set
87                if the object is currently the active object.</li>
88            <li><const scope="com::sun::star::accessibility"
89                >AccessibleStateType::DEFUNC</const>
90                is set if the object has already been disposed
91                and subsequent calls to this object result in
92                <type scope="com::sun::star::lang">DisposedException</type>
93                exceptions.</li>
94            <li><const scope="com::sun::star::accessibility"
95                >AccessibleStateType::ENABLED</const> is set
96                if the object is enabled.</li>
97            <li><const scope="com::sun::star::accessibility"
98                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
99            <li><const scope="com::sun::star::accessibility"
100                >AccessibleStateType::FOCUSED</const> is set
101                if the object currently has the keyboard focus.</li>
102            <li><const scope="com::sun::star::accessibility"
103                >AccessibleStateType::MODAL</const> is set
104                if the object is modal.</li>
105            <li><const scope="com::sun::star::accessibility"
106                >AccessibleStateType::RESIZABLE</const> is set
107                if the size of the object is not fixed.</li>
108            <li><const scope="com::sun::star::accessibility"
109                >AccessibleStateType::SHOWING</const> is set
110                if the object is displayed on the screen.</li>
111            <li><const scope="com::sun::star::accessibility"
112                >AccessibleStateType::VISIBLE</const> is always set.</li>
113            </ul>
114            </li>
115        </ul>
116     */
117    interface ::com::sun::star::accessibility::XAccessibleContext;
118    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
119    interface ::com::sun::star::accessibility::XAccessibleComponent;
120    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
121};
122
123}; }; }; };
124
125#endif
126