1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_awt_AccessibleEdit_idl__
25#define __com_sun_star_awt_AccessibleEdit_idl__
26
27#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
28#include <com/sun/star/accessibility/XAccessibleContext.idl>
29#endif
30#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
31#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
32#endif
33#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
34#include <com/sun/star/accessibility/XAccessibleComponent.idl>
35#endif
36#ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
37#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
38#endif
39#ifndef __com_sun_star_accessibility_XAccessibleText_idl__
40#include <com/sun/star/accessibility/XAccessibleText.idl>
41#endif
42#ifndef __com_sun_star_accessibility_XAccessibleEditableText_idl__
43#include <com/sun/star/accessibility/XAccessibleEditableText.idl>
44#endif
45
46module com { module sun { module star { module awt {
47
48/** specifies accessibility support for an edit.
49
50    @since OpenOffice 1.1.2
51 */
52published service AccessibleEdit
53{
54    /** This interface gives access to the structural information of an edit:
55
56        <ul>
57        <li>Role: The role of an edit is <const
58            scope="com::sun::star::accessibility"
59            >AccessibleRole::TEXT</const>.
60            If the text content of the edit is password protected
61            the role is <const scope="com::sun::star::accessibility"
62            >AccessibleRole::PASSWORD_TEXT</const>.</li>
63        <li>Name: If the relation of type <const
64            scope="com::sun::star::accessibility"
65            >AccessibleRelationType::LABELED_BY</const> is set,
66            the name of the edit is the localized label of the target
67            object, otherwise there is no name.</li>
68        <li>Description: The description of an edit 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 edit.</li>
72        <li>Relations: The relations supported by this service are
73            <ul>
74            <li><const scope="com::sun::star::accessibility"
75                >AccessibleRelationType::LABELED_BY</const> is set
76                if the object is labeled by one or more target
77                objects.</li>
78            </ul>
79            </li>
80        <li>States: The states supported by this service are
81            <ul>
82            <li><const scope="com::sun::star::accessibility"
83                >AccessibleStateType::DEFUNC</const>
84                is set if the object has already been disposed
85                and subsequent calls to this object result in
86                <type scope="com::sun::star::lang">DisposedException</type>
87                exceptions.</li>
88            <li><const scope="com::sun::star::accessibility"
89                >AccessibleStateType::EDITABLE</const> is set
90                if the content of the object can be changed by the user.</li>
91            <li><const scope="com::sun::star::accessibility"
92                >AccessibleStateType::ENABLED</const> is set
93                if the object is enabled.</li>
94            <li><const scope="com::sun::star::accessibility"
95                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
96            <li><const scope="com::sun::star::accessibility"
97                >AccessibleStateType::FOCUSED</const> is set
98                if the object currently has the keyboard focus.</li>
99            <li><const scope="com::sun::star::accessibility"
100                >AccessibleStateType::SHOWING</const> is set
101                if the object is displayed on the screen.</li>
102            <li><const scope="com::sun::star::accessibility"
103                >AccessibleStateType::VISIBLE</const> is always set.</li>
104            </ul>
105            </li>
106        </ul>
107     */
108    interface ::com::sun::star::accessibility::XAccessibleContext;
109
110    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
111
112    interface ::com::sun::star::accessibility::XAccessibleComponent;
113
114    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
115
116    /** This interface gives read-only access to the text representation
117        of an edit.
118     */
119    interface ::com::sun::star::accessibility::XAccessibleText;
120
121    /** This interface extends the
122        <type scope="com::sun::star::accessibility">XAccessibleText</type>
123        interface and gives read and write access to the text representation
124        of an edit.
125     */
126    interface ::com::sun::star::accessibility::XAccessibleEditableText;
127};
128
129}; }; }; };
130
131#endif
132