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_accessibility_AccessibleTextField_idl__
25#define __com_sun_star_accessibility_AccessibleTextField_idl__
26
27#ifndef __com_sun_star_accessibility_AccessibleContext_idl__
28#include <com/sun/star/accessibility/AccessibleContext.idl>
29#endif
30
31
32module com { module sun { module star { module accessibility {
33
34 published interface XAccessibleExtendedComponent;
35 published interface XAccessibleComponent;
36 published interface XAccessibleText;
37
38}; }; }; };
39
40module com { module sun { module star { module awt {
41
42
43/** Text fields are like edit fields as described by the
44    <type>AccessibleEdit</type> service but without the ability to edit the
45    text.
46    @see com::sun::star::accessibility::AccessibleContext
47    @see com::sun::star::accessibility::XAccessibleComponent
48	@see com::sun::star::accessibility::XAccessibleExtendedComponent
49	@see com::sun::star::accessibility::XAccessibleText
50
51	@since OpenOffice 1.1.2
52*/
53published service AccessibleTextField
54{
55	/** This interface gives access to the structural information of a text filed:
56
57       <ul>
58       <li>Role: The role of a text filed is <const
59           scope="com::sun::star::accessibility"
60           >AccessibleRole::TEXT</const>.</li>
61       <li>Name: The name of a text filed is its localized label.</li>
62       <li>Description: The description of a text filed is its localized
63           help text.</li>
64       <li>Children: There exists no children.</li>
65       <li>Parent: The parent is the window that contains the text filed.</li>
66       <li>Relations: There are no relations.</li>
67       <li>States: The states supported by this service are
68           <ul>
69           <li><const scope="com::sun::star::accessibility"
70               >AccessibleStateType::DEFUNC</const>
71               is set if the object has already been disposed
72               and subsequent calls to this object result in
73               <type scope="com::sun::star::lang">DisposedException</type>
74               exceptions.</li>
75           <li><const scope="com::sun::star::accessibility"
76               >AccessibleStateType::ENABLED</const> is set
77               if the object is enabled.</li>
78           <li><const scope="com::sun::star::accessibility"
79               >AccessibleStateType::FOCUSABLE</const> is always set.</li>
80           <li><const scope="com::sun::star::accessibility"
81               >AccessibleStateType::FOCUSED</const> is set
82               if the object currently has the keyboard focus.</li>
83           <li><const scope="com::sun::star::accessibility"
84               >AccessibleStateType::ACTIVE</const> is set
85               if a child has currently the focus.</li>
86		   <li><const scope="com::sun::star::accessibility"
87               >AccessibleStateType::RESIZABLE</const> is set
88               if the object can be resized.</li>
89           <li><const scope="com::sun::star::accessibility"
90               >AccessibleStateType::SHOWING</const> is set
91               if the object is displayed on the screen.</li>
92           <li><const scope="com::sun::star::accessibility"
93               >AccessibleStateType::VISIBLE</const> is always set.</li>
94           </ul>
95           </li>
96       </ul>
97    */
98
99    service   com::sun::star::accessibility::AccessibleContext;
100
101    /** This interface gives read-only access to the text representation
102        of a text field.
103     */
104    interface com::sun::star::accessibility::XAccessibleText;
105	interface com::sun::star::accessibility::XAccessibleComponent;
106	interface com::sun::star::accessibility::XAccessibleExtendedComponent;
107
108};
109
110}; }; }; };
111
112#endif
113