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