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_AccessibleSpreadsheetDocumentView_idl__
28#define __com_sun_star_sheet_AccessibleSpreadsheetDocumentView_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//=============================================================================
52
53module com {  module sun {  module star {  module table {
54
55//=============================================================================
56
57/** The accessible view of a table in a text document or in the page preview
58  	of a spreadsheet document. See
59	<type scope="::com::sun::star::sheet">AccessibleSpreadsheet</type> for
60    tables in the edit view of a spreadsheet.
61    @since OOo 1.1.2
62*/
63published service AccessibleTableView
64{
65	/** This interface gives access to any table cell that is contained in
66	  	a table fragment that is at least partially visible. A table fragment
67		is the part of a table that is displayed at a single page.
68
69	<ul>
70		<li>The parent returned by
71            <method scope="::com::sun::star::accessibility"
72            >XAccessibleContext::getAccessibleParent</method>
73			is the accessible text document view, a page of the accessible
74		    text documenent page preview, or the accessible spreadsheet
75			page preview.</li>
76		<li>The children returned by
77            <method scope="::com::sun::star::accessibility"
78            >XAccessibleContext::getAccessibleChild</method> all
79			support the interface XAccessible. Calling
80			<method scope="::com::sun::star::accessibility"
81            >XAccessible::getAccessibleContext</method> for these children
82            returns an object that supports the service.
83			<type scope="::com::sun::star::table">AccessibleCellView</type>:
84			A child where calling
85            <method scope="::com::sun::star::accessibility"
86            >XAccessibleContext::getAccessibleChild</method>
87			an object that supports this service is returned for
88			every partially visible cell in this table.
89		<p>The following rules apply to the children order.</p>
90		<ul>
91			<li>All the children are cells. The order of this cells is to
92			the order on the screen. This means that the first cell is the
93			cell in the left top edge of the table and the last one is the
94			cell in the right bottom edge of the table. The second is the
95			cell in the first row and second xolumn and so on.</li>
96		</ul>
97		<li>The description is ???.</li>
98		<li>The name is the given table name and a number to make it non-ambiguous.</li>
99		<li>The role is <const scope="::com::sun::star::accessibility"
100            >AccessibleRole::TABLE</const></li>
101		<li>In a spreadsheet page preview there are relations between the
102			table and the shapes with an anchor
103			on this table (not with an anchor on a cell in this table).</li>
104		<li>The following states are supported:
105			<ul>
106				<li><const scope="::com::sun::star::accessibility"
107                    >AccessibleStateType::DEFUNC</const> is always false if the
108                    table is not deleted, the document is open. Also it is
109                    false if the table was showed in a page preview and the
110                    page preview is allready opend, otherwise it is true.</li>
111				<li><const scope="::com::sun::star::accessibility"
112                    >AccessibleStateType::EDITABLE</const> is false if the
113                    table is showed in a page preview or the table is
114                    protected, otherwise it is true.</li>
115				<li><const scope="::com::sun::star::accessibility"
116                    >AccessibleStateType::ENABLED</const> is always true.</li>
117				<li><const scope="::com::sun::star::accessibility"
118                    >AccessibleStateType::MULTI_SELECTABLE</const> is false
119                    if the table is showed in a page preview, otherwise it is
120                    true.</li>
121				<li><const scope="::com::sun::star::accessibility"
122                    >AccessibleStateType::OPAQUE</const> is false, if the table
123                    has no background color or graphic, otherwise it is
124                    false.</li>
125				<li><const scope="::com::sun::star::accessibility"
126                    >AccessibleStateType::SHOWING</const>Is true if the
127                    Bounding Box lies in the Bounding Box of the parent.
128                    Otherwise it is false.</li>
129				<li><const scope="::com::sun::star::accessibility"
130                    >AccessibleStateType::VISIBLE</const>Is always true.</li>
131			</ul>
132		</li>
133	</ul>
134
135	 */
136	interface ::com::sun::star::accessibility::XAccessibleContext;
137
138	/** This interface gives access to the visibility of the document.
139	*/
140	interface ::com::sun::star::accessibility::XAccessibleComponent;
141
142	/** This interface gives access to any cell that is at least partially
143		visible on the screen. So this interface gives access to the same
144		things like the XAccessibleContext interface. Therefor it use more
145		usable methods. Also it gives access to some table specific data.
146	 */
147	interface ::com::sun::star::accessibility::XAccessibleTable;
148
149	/** This interface is for selecting the cells. This interface is optional.
150	 */
151	[optional] interface ::com::sun::star::accessibility::XAccessibleSelection;
152
153	/** This is the interface for listeners */
154	interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
155};
156
157//=============================================================================
158
159}; }; }; };
160
161#endif
162