1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_sheet_AccessibleSpreadsheet_idl__
24cdf0e10cSrcweir#define __com_sun_star_sheet_AccessibleSpreadsheet_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
27cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleContext.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
31cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleComponent.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleTable_idl__
35cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleTable.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleSelection_idl__
39cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleSelection.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
43cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
44cdf0e10cSrcweir#endif
45cdf0e10cSrcweir
46cdf0e10cSrcweir//=============================================================================
47cdf0e10cSrcweir
48cdf0e10cSrcweirmodule com {  module sun {  module star {  module sheet {
49cdf0e10cSrcweir
50cdf0e10cSrcweir//=============================================================================
51cdf0e10cSrcweir
52cdf0e10cSrcweir/** The accessible view of a spreadsheet document
53cdf0e10cSrcweir
54cdf0e10cSrcweir	 @since OOo 1.1.2
55cdf0e10cSrcweir*/
56cdf0e10cSrcweirpublished service AccessibleSpreadsheet
57cdf0e10cSrcweir{
58cdf0e10cSrcweir	/** This interface gives access to any object in the currently visible table
59cdf0e10cSrcweir		on the desktop.
60cdf0e10cSrcweir
61cdf0e10cSrcweir	<ul>
62cdf0e10cSrcweir		<li>The parent returned by <method scope="::com::sun::star::accessibility"
63cdf0e10cSrcweir            >XAccessibleContext::getAccessibleParent</method>
64cdf0e10cSrcweir			is the accessible spreadsheet document view.</li>
65cdf0e10cSrcweir		<li>The children returned by <method scope="::com::sun::star::accessibility"
66cdf0e10cSrcweir            >XAccessibleContext::getAccessibleChild</method> all
67cdf0e10cSrcweir			support the interface XAccessible. Calling
68cdf0e10cSrcweir			<method scope="::com::sun::star::accessibility"
69cdf0e10cSrcweir            >XAccessible::getAccessibleContext</method> for these children
70cdf0e10cSrcweir            returns an object that supports the following service.</li>
71cdf0e10cSrcweir		<ul>
72cdf0e10cSrcweir			<li><type scope="::com::sun::star::sheet">AccessibleCell</type>:
73cdf0e10cSrcweir				A child where calling
74cdf0e10cSrcweir                <method scope="::com::sun::star::accessibility"
75cdf0e10cSrcweir                >XAccessibleContext::getAccessibleChild</method>
76cdf0e10cSrcweir				an object that supports this service is returned for
77cdf0e10cSrcweir				every cell in this table.</li>
78cdf0e10cSrcweir		</ul>
79cdf0e10cSrcweir		<p>The following rules apply to the children order.</p>
80cdf0e10cSrcweir		<ul>
81cdf0e10cSrcweir			<li>All the children are cells. The order of this cells is to
82cdf0e10cSrcweir			the order on the screen. This means that the first cell is the
83cdf0e10cSrcweir			cell in the left top edge of the table and the last one is the
84cdf0e10cSrcweir			cell in the right bottom edge of the table. The second is the
85cdf0e10cSrcweir			cell in the first row and second xolumn and so on.</li>
86cdf0e10cSrcweir		</ul>
87cdf0e10cSrcweir		<li>The description is ???.</li>
88cdf0e10cSrcweir		<li>The name is the given table name.</li>
89cdf0e10cSrcweir		<li>The role is <const scope="::com::sun::star::accessibility"
90cdf0e10cSrcweir            >AccessibleRole::TABLE</const></li>
91cdf0e10cSrcweir		<li>There are relations between the table and the shapes with an anchor
92cdf0e10cSrcweir			on this table (not with an anchor on a cell in this table).</li>
93cdf0e10cSrcweir		<li>The following states are supported:
94cdf0e10cSrcweir			<ul>
95cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
96cdf0e10cSrcweir                    >AccessibleStateType::DEFUNC</const> is always false if the
97cdf0e10cSrcweir                    table is not deleted and the document is open, otherwise it
98cdf0e10cSrcweir                    is true.</li>
99cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
100cdf0e10cSrcweir                    >AccessibleStateType::EDITABLE</const> is false if the
101cdf0e10cSrcweir                    table is protected, otherwise it is true.</li>
102cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
103cdf0e10cSrcweir                    >AccessibleStateType::ENABLED</const> is always true.</li>
104cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
105cdf0e10cSrcweir                    >AccessibleStateType::MULTI_SELECTABLE</const> is always
106cdf0e10cSrcweir                    true.</li>
107cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
108cdf0e10cSrcweir                    >AccessibleStateType::OPAQUE</const> is always true.</li>
109cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
110cdf0e10cSrcweir                    >AccessibleStateType::RESIZEABLE</const>is always
111cdf0e10cSrcweir                    false.</li>
112cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
113cdf0e10cSrcweir                    >AccessibleStateType::SELECTABLE</const> is always
114cdf0e10cSrcweir                    true.</li>
115cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
116cdf0e10cSrcweir                    >AccessibleStateType::SELECTED</const> is true if the
117cdf0e10cSrcweir                    complete table (all cells) is selected.</li>
118cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
119cdf0e10cSrcweir                    >AccessibleStateType::SHOWING</const>Is true if the
120cdf0e10cSrcweir                    Bounding Box lies in the Bounding Box of the parent.
121cdf0e10cSrcweir                    Otherwise it is false.</li>
122cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
123cdf0e10cSrcweir                    >AccessibleStateType::VISIBLE</const>Is always true.</li>
124cdf0e10cSrcweir			</ul>
125cdf0e10cSrcweir		</li>
126cdf0e10cSrcweir	</ul>
127cdf0e10cSrcweir	 */
128cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleContext;
129cdf0e10cSrcweir
130cdf0e10cSrcweir	/** This interface gives access to the visibility of the table.
131cdf0e10cSrcweir	*/
132cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleComponent;
133cdf0e10cSrcweir
134cdf0e10cSrcweir	/** This interface gives access to any cell that is at least partially
135cdf0e10cSrcweir		visible on the screen. So this interface gives access to the same
136cdf0e10cSrcweir		things like the XAccessibleContext interface. Therefor it use more
137cdf0e10cSrcweir		usable methods. Also it gives access to some table specific data.
138cdf0e10cSrcweir	 */
139cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleTable;
140cdf0e10cSrcweir
141cdf0e10cSrcweir	/** This interface is for selecting the cells.
142cdf0e10cSrcweir	 */
143cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleSelection;
144cdf0e10cSrcweir
145cdf0e10cSrcweir	/** This is the interface for listeners */
146cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
147cdf0e10cSrcweir};
148cdf0e10cSrcweir
149cdf0e10cSrcweir//=============================================================================
150cdf0e10cSrcweir
151cdf0e10cSrcweir}; }; }; };
152cdf0e10cSrcweir
153cdf0e10cSrcweir#endif
154