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_AccessibleEdit_idl__
29#define __com_sun_star_awt_AccessibleEdit_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_XAccessibleEditableText_idl__
47#include <com/sun/star/accessibility/XAccessibleEditableText.idl>
48#endif
49
50module com { module sun { module star { module awt {
51
52/** specifies accessibility support for an edit.
53
54    @since OOo 1.1.2
55 */
56published service AccessibleEdit
57{
58    /** This interface gives access to the structural information of an edit:
59
60        <ul>
61        <li>Role: The role of an edit is <const
62            scope="com::sun::star::accessibility"
63            >AccessibleRole::TEXT</const>.
64            If the text content of the edit is password protected
65            the role is <const scope="com::sun::star::accessibility"
66            >AccessibleRole::PASSWORD_TEXT</const>.</li>
67        <li>Name: If the relation of type <const
68            scope="com::sun::star::accessibility"
69            >AccessibleRelationType::LABELED_BY</const> is set,
70            the name of the edit is the localized label of the target
71            object, otherwise there is no name.</li>
72        <li>Description: The description of an edit is its localized
73            help text.</li>
74        <li>Children: There are no children.</li>
75        <li>Parent: The parent is the window that contains the edit.</li>
76        <li>Relations: The relations supported by this service are
77            <ul>
78            <li><const scope="com::sun::star::accessibility"
79                >AccessibleRelationType::LABELED_BY</const> is set
80                if the object is labeled by one or more target
81                objects.</li>
82            </ul>
83            </li>
84        <li>States: The states supported by this service are
85            <ul>
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::EDITABLE</const> is set
94                if the content of the object can be changed by the user.</li>
95            <li><const scope="com::sun::star::accessibility"
96                >AccessibleStateType::ENABLED</const> is set
97                if the object is enabled.</li>
98            <li><const scope="com::sun::star::accessibility"
99                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
100            <li><const scope="com::sun::star::accessibility"
101                >AccessibleStateType::FOCUSED</const> is set
102                if the object currently has the keyboard focus.</li>
103            <li><const scope="com::sun::star::accessibility"
104                >AccessibleStateType::SHOWING</const> is set
105                if the object is displayed on the screen.</li>
106            <li><const scope="com::sun::star::accessibility"
107                >AccessibleStateType::VISIBLE</const> is always set.</li>
108            </ul>
109            </li>
110        </ul>
111     */
112    interface ::com::sun::star::accessibility::XAccessibleContext;
113
114    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
115
116    interface ::com::sun::star::accessibility::XAccessibleComponent;
117
118    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
119
120    /** This interface gives read-only access to the text representation
121        of an edit.
122     */
123    interface ::com::sun::star::accessibility::XAccessibleText;
124
125    /** This interface extends the
126        <type scope="com::sun::star::accessibility">XAccessibleText</type>
127        interface and gives read and write access to the text representation
128        of an edit.
129     */
130    interface ::com::sun::star::accessibility::XAccessibleEditableText;
131};
132
133}; }; }; };
134
135#endif
136