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#ifndef __com_sun_star_sheet_AccessibleSpreadsheet_idl__
24#define __com_sun_star_sheet_AccessibleSpreadsheet_idl__
25
26#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
27#include <com/sun/star/accessibility/XAccessibleContext.idl>
28#endif
29
30#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
31#include <com/sun/star/accessibility/XAccessibleComponent.idl>
32#endif
33
34#ifndef __com_sun_star_accessibility_XAccessibleTable_idl__
35#include <com/sun/star/accessibility/XAccessibleTable.idl>
36#endif
37
38#ifndef __com_sun_star_accessibility_XAccessibleSelection_idl__
39#include <com/sun/star/accessibility/XAccessibleSelection.idl>
40#endif
41
42#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
43#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
44#endif
45
46//=============================================================================
47
48module com {  module sun {  module star {  module sheet {
49
50//=============================================================================
51
52/** The accessible view of a spreadsheet document
53
54	 @since OpenOffice 1.1.2
55*/
56published service AccessibleSpreadsheet
57{
58	/** This interface gives access to any object in the currently visible table
59		on the desktop.
60
61	<ul>
62		<li>The parent returned by <method scope="::com::sun::star::accessibility"
63            >XAccessibleContext::getAccessibleParent</method>
64			is the accessible spreadsheet document view.</li>
65		<li>The children returned by <method scope="::com::sun::star::accessibility"
66            >XAccessibleContext::getAccessibleChild</method> all
67			support the interface XAccessible. Calling
68			<method scope="::com::sun::star::accessibility"
69            >XAccessible::getAccessibleContext</method> for these children
70            returns an object that supports the following service.</li>
71		<ul>
72			<li><type scope="::com::sun::star::sheet">AccessibleCell</type>:
73				A child where calling
74                <method scope="::com::sun::star::accessibility"
75                >XAccessibleContext::getAccessibleChild</method>
76				an object that supports this service is returned for
77				every cell in this table.</li>
78		</ul>
79		<p>The following rules apply to the children order.</p>
80		<ul>
81			<li>All the children are cells. The order of this cells is to
82			the order on the screen. This means that the first cell is the
83			cell in the left top edge of the table and the last one is the
84			cell in the right bottom edge of the table. The second is the
85			cell in the first row and second xolumn and so on.</li>
86		</ul>
87		<li>The description is ???.</li>
88		<li>The name is the given table name.</li>
89		<li>The role is <const scope="::com::sun::star::accessibility"
90            >AccessibleRole::TABLE</const></li>
91		<li>There are relations between the table and the shapes with an anchor
92			on this table (not with an anchor on a cell in this table).</li>
93		<li>The following states are supported:
94			<ul>
95				<li><const scope="::com::sun::star::accessibility"
96                    >AccessibleStateType::DEFUNC</const> is always false if the
97                    table is not deleted and the document is open, otherwise it
98                    is true.</li>
99				<li><const scope="::com::sun::star::accessibility"
100                    >AccessibleStateType::EDITABLE</const> is false if the
101                    table is protected, otherwise it is true.</li>
102				<li><const scope="::com::sun::star::accessibility"
103                    >AccessibleStateType::ENABLED</const> is always true.</li>
104				<li><const scope="::com::sun::star::accessibility"
105                    >AccessibleStateType::MULTI_SELECTABLE</const> is always
106                    true.</li>
107				<li><const scope="::com::sun::star::accessibility"
108                    >AccessibleStateType::OPAQUE</const> is always true.</li>
109				<li><const scope="::com::sun::star::accessibility"
110                    >AccessibleStateType::RESIZEABLE</const>is always
111                    false.</li>
112				<li><const scope="::com::sun::star::accessibility"
113                    >AccessibleStateType::SELECTABLE</const> is always
114                    true.</li>
115				<li><const scope="::com::sun::star::accessibility"
116                    >AccessibleStateType::SELECTED</const> is true if the
117                    complete table (all cells) is selected.</li>
118				<li><const scope="::com::sun::star::accessibility"
119                    >AccessibleStateType::SHOWING</const>Is true if the
120                    Bounding Box lies in the Bounding Box of the parent.
121                    Otherwise it is false.</li>
122				<li><const scope="::com::sun::star::accessibility"
123                    >AccessibleStateType::VISIBLE</const>Is always true.</li>
124			</ul>
125		</li>
126	</ul>
127	 */
128	interface ::com::sun::star::accessibility::XAccessibleContext;
129
130	/** This interface gives access to the visibility of the table.
131	*/
132	interface ::com::sun::star::accessibility::XAccessibleComponent;
133
134	/** This interface gives access to any cell that is at least partially
135		visible on the screen. So this interface gives access to the same
136		things like the XAccessibleContext interface. Therefor it use more
137		usable methods. Also it gives access to some table specific data.
138	 */
139	interface ::com::sun::star::accessibility::XAccessibleTable;
140
141	/** This interface is for selecting the cells.
142	 */
143	interface ::com::sun::star::accessibility::XAccessibleSelection;
144
145	/** This is the interface for listeners */
146	interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
147};
148
149//=============================================================================
150
151}; }; }; };
152
153#endif
154