summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/AccessibleWindow.idl
blob: 0c0aa97029f083c262671eec8b9a206fe0acedd8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: AccessibleWindow.idl,v $
 * $Revision: 1.7 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_awt_AccessibleWindow_idl__
#define __com_sun_star_awt_AccessibleWindow_idl__

#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
#include <com/sun/star/accessibility/XAccessibleContext.idl>
#endif
#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
#endif
#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
#include <com/sun/star/accessibility/XAccessibleComponent.idl>
#endif
#ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
#endif

module com { module sun { module star { module awt {
    
/** specifies accessibility support for a window.
    
    @since OOo 1.1.2
 */
published service AccessibleWindow
{
    /** This interface gives access to the structural information of a window:

        <ul>
        <li>Role: The role of a window is not fixed. A window may have
            one of the following roles:
            <ul>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleRole::DIALOG</const></li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleRole::FRAME</const></li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleRole::LAYERED_PANE</const></li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleRole::PANEL</const></li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleRole::ROOT_PANE</const></li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleRole::SCROLL_PANE</const></li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleRole::SPLIT_PANE</const></li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleRole::WINDOW</const></li>
            <li>...</li>               
            </ul>
            </li>     
        <li>Name: The name of a window is its localized title.</li>
        <li>Description: The description of a window is its localized
            help text.</li>
        <li>Children: The children of a window are the child windows.</li>
        <li>Parent: The parent of a window is the parent window.</li>
        <li>Relations: There are no relations.</li>
        <li>States: The states supported by this service are
            <ul>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleStateType::ACTIVE</const> is set
                if the object is currently the active object.</li>    
            <li><const scope="com::sun::star::accessibility"
                >AccessibleStateType::DEFUNC</const>
                is set if the object has already been disposed
                and subsequent calls to this object result in				
                <type scope="com::sun::star::lang">DisposedException</type>
                exceptions.</li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleStateType::ENABLED</const> is set
                if the object is enabled.</li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleStateType::FOCUSED</const> is set
                if the object currently has the keyboard focus.</li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleStateType::MODAL</const> is set
                if the object is modal.</li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleStateType::RESIZABLE</const> is set
                if the size of the object is not fixed.</li> 
            <li><const scope="com::sun::star::accessibility"
                >AccessibleStateType::SHOWING</const> is set
                if the object is displayed on the screen.</li>
            <li><const scope="com::sun::star::accessibility"
                >AccessibleStateType::VISIBLE</const> is always set.</li>
            </ul>
            </li>
        </ul>
     */
    interface ::com::sun::star::accessibility::XAccessibleContext;
    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
    interface ::com::sun::star::accessibility::XAccessibleComponent;
    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
};

}; }; }; };

#endif