bump product version to 4.1.6.2
[LibreOffice.git] / offapi / com / sun / star / awt / AccessibleTextField.idl
blob472c7a7d827ce0d00cd3d7bd627a388d107656da
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /**
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
20 #ifndef __com_sun_star_awt_AccessibleTextField_idl__
21 #define __com_sun_star_awt_AccessibleTextField_idl__
23 #include <com/sun/star/accessibility/AccessibleContext.idl>
26 module com { module sun { module star { module accessibility {
28 interface XAccessibleExtendedComponent;
29 interface XAccessibleComponent;
30 interface XAccessibleText;
32 }; }; }; };
34 module com { module sun { module star { module awt {
37 /** Text fields are like edit fields as described by the
38 <type>AccessibleEdit</type> service but without the ability to edit the
39 text.
40 @see com::sun::star::accessibility::AccessibleContext
41 @see com::sun::star::accessibility::XAccessibleComponent
42 @see com::sun::star::accessibility::XAccessibleExtendedComponent
43 @see com::sun::star::accessibility::XAccessibleText
45 @since OOo 1.1.2
47 service AccessibleTextField
49 /** This interface gives access to the structural information of a text filed:
51 <ul>
52 <li>Role: The role of a text filed is <const
53 scope="com::sun::star::accessibility"
54 >AccessibleRole::TEXT</const>.</li>
55 <li>Name: The name of a text filed is its localized label.</li>
56 <li>Description: The description of a text filed is its localized
57 help text.</li>
58 <li>Children: There exists no children.</li>
59 <li>Parent: The parent is the window that contains the text filed.</li>
60 <li>Relations: There are no relations.</li>
61 <li>States: The states supported by this service are
62 <ul>
63 <li><const scope="com::sun::star::accessibility"
64 >AccessibleStateType::DEFUNC</const>
65 is set if the object has already been disposed
66 and subsequent calls to this object result in
67 <type scope="com::sun::star::lang">DisposedException</type>
68 exceptions.</li>
69 <li><const scope="com::sun::star::accessibility"
70 >AccessibleStateType::ENABLED</const> is set
71 if the object is enabled.</li>
72 <li><const scope="com::sun::star::accessibility"
73 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
74 <li><const scope="com::sun::star::accessibility"
75 >AccessibleStateType::FOCUSED</const> is set
76 if the object currently has the keyboard focus.</li>
77 <li><const scope="com::sun::star::accessibility"
78 >AccessibleStateType::ACTIVE</const> is set
79 if a child has currently the focus.</li>
80 <li><const scope="com::sun::star::accessibility"
81 >AccessibleStateType::RESIZABLE</const> is set
82 if the object can be resized.</li>
83 <li><const scope="com::sun::star::accessibility"
84 >AccessibleStateType::SHOWING</const> is set
85 if the object is displayed on the screen.</li>
86 <li><const scope="com::sun::star::accessibility"
87 >AccessibleStateType::VISIBLE</const> is always set.</li>
88 </ul>
89 </li>
90 </ul>
93 service com::sun::star::accessibility::AccessibleContext;
95 /** This interface gives read-only access to the text representation
96 of a text field.
98 interface com::sun::star::accessibility::XAccessibleText;
99 interface com::sun::star::accessibility::XAccessibleComponent;
100 interface com::sun::star::accessibility::XAccessibleExtendedComponent;
104 }; }; }; };
106 #endif
108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */