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_AccessibleList_idl__
25#define __com_sun_star_awt_AccessibleList_idl__
26
27#ifndef __com_sun_star_accessibility_AccessibleContext_idl__
28#include <com/sun/star/accessibility/AccessibleContext.idl>
29#endif
30
31module com { module sun { module star { module accessibility {
32
33 published interface XAccessible;
34 published interface XAccessibleExtendedComponent;
35 published interface XAccessibleComponent;
36 published interface XAccessibleSelection;
37
38}; }; }; };
39
40module com { module sun { module star { module awt {
41
42
43
44/** Accessible lists are used by combo boxes as container for
45    the list items.
46
47	@see com::sun::star::accessibility::AccessibleContext
48
49    @see com::sun::star::accessibility::XAccessibleComponent
50	@see com::sun::star::accessibility::XAccessibleExtendedComponent
51	@see ::com::sun::star::accessibility::XAccessibleSelection
52
53	@since OpenOffice 1.1.2
54*/
55published service AccessibleList
56{
57	/** This interface gives access to the structural information of a list:
58
59       <ul>
60       <li>Role: The role of a list is <const
61           scope="::com::sun::star::accessibility"
62           >AccessibleRole::LIST</const>.</li>
63       <li>Name: The name of a list is its localized label.</li>
64       <li>Description: The description of a list is its localized
65           help text.</li>
66       <li>Children: There exists children.
67			Each child is of type <type scope="com::sun::star::awt">AccessibleListItem</type>. </li>
68       <li>Parent: The parent can be of type
69			<ul>
70			<li>
71				<type scope="com::sun::star::awt">AccessibleComboBox</type>
72				<type scope="com::sun::star::awt">AccessibleListBox</type>
73				<type scope="com::sun::star::awt">AccessibleDropDownListBox</type>
74				<type scope="com::sun::star::awt">AccessibleDropDownComboBox</type>
75			</li>
76			.
77	   </li>
78       <li>Relations: There are no relations.</li>
79       <li>States: The states supported by this service are
80           <ul>
81           <li><const scope="com::sun::star::accessibility"
82               >AccessibleStateType::DEFUNC</const>
83               is set if the object has already been disposed
84               and subsequent calls to this object result in
85               <type scope="com::sun::star::lang">DisposedException</type>
86               exceptions.</li>
87           <li><const scope="com::sun::star::accessibility"
88               >AccessibleStateType::ENABLED</const> is set
89               if the object is enabled.</li>
90           <li><const scope="com::sun::star::accessibility"
91               >AccessibleStateType::FOCUSABLE</const> is always set.</li>
92           <li><const scope="com::sun::star::accessibility"
93               >AccessibleStateType::FOCUSED</const> is set
94               if the object currently has the keyboard focus.</li>
95           <li><const scope="com::sun::star::accessibility"
96               >AccessibleStateType::ACTIVE</const> is set
97               if a child has currently the focus.</li>
98		   <li><const scope="com::sun::star::accessibility"
99               >AccessibleStateType::RESIZABLE</const> is set
100               if the object can be resized.</li>
101           <li><const scope="com::sun::star::accessibility"
102               >AccessibleStateType::SHOWING</const> is set
103               if the object is displayed on the screen.</li>
104           <li><const scope="com::sun::star::accessibility"
105               >AccessibleStateType::VISIBLE</const> is always set.</li>
106		   <li><const scope="com::sun::star::accessibility"
107               >AccessibleStateType::MULTI_SELECTABLE</const> is set
108			   if the list supports multi selection.</li>
109		   <li><const scope="com::sun::star::accessibility"
110               >AccessibleStateType::MANAGES_DESCENDANTS</const> is always set.
111			   The children are transient.</li>
112           </ul>
113           </li>
114       </ul>
115    */
116    service   com::sun::star::accessibility::AccessibleContext;
117
118	interface com::sun::star::accessibility::XAccessibleComponent;
119	interface com::sun::star::accessibility::XAccessibleExtendedComponent;
120
121    /** Support of the <type scope="com::sun::star::accessibility">XAccessible</type> interface may be
122        discontinued in the future.
123    */
124    interface com::sun::star::accessibility::XAccessible;
125
126    /** This interface gives access to the selectable children of a
127        list.
128     */
129	interface com::sun::star::accessibility::XAccessibleSelection;
130};
131
132}; }; }; };
133
134#endif
135