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