1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_sheet_AccessibleSpreadsheetDocumentView_idl__
24cdf0e10cSrcweir#define __com_sun_star_sheet_AccessibleSpreadsheetDocumentView_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//=============================================================================
48cdf0e10cSrcweir
49cdf0e10cSrcweirmodule com {  module sun {  module star {  module table {
50cdf0e10cSrcweir
51cdf0e10cSrcweir//=============================================================================
52cdf0e10cSrcweir
53cdf0e10cSrcweir/** The accessible view of a table in a text document or in the page preview
54cdf0e10cSrcweir  	of a spreadsheet document. See
55cdf0e10cSrcweir	<type scope="::com::sun::star::sheet">AccessibleSpreadsheet</type> for
56cdf0e10cSrcweir    tables in the edit view of a spreadsheet.
5796af39f7SJürgen Schmidt    @since OpenOffice 1.1.2
58cdf0e10cSrcweir*/
59cdf0e10cSrcweirpublished service AccessibleTableView
60cdf0e10cSrcweir{
61cdf0e10cSrcweir	/** This interface gives access to any table cell that is contained in
62cdf0e10cSrcweir	  	a table fragment that is at least partially visible. A table fragment
63cdf0e10cSrcweir		is the part of a table that is displayed at a single page.
64cdf0e10cSrcweir
65cdf0e10cSrcweir	<ul>
66cdf0e10cSrcweir		<li>The parent returned by
67cdf0e10cSrcweir            <method scope="::com::sun::star::accessibility"
68cdf0e10cSrcweir            >XAccessibleContext::getAccessibleParent</method>
69cdf0e10cSrcweir			is the accessible text document view, a page of the accessible
70cdf0e10cSrcweir		    text documenent page preview, or the accessible spreadsheet
71cdf0e10cSrcweir			page preview.</li>
72cdf0e10cSrcweir		<li>The children returned by
73cdf0e10cSrcweir            <method scope="::com::sun::star::accessibility"
74cdf0e10cSrcweir            >XAccessibleContext::getAccessibleChild</method> all
75cdf0e10cSrcweir			support the interface XAccessible. Calling
76cdf0e10cSrcweir			<method scope="::com::sun::star::accessibility"
77cdf0e10cSrcweir            >XAccessible::getAccessibleContext</method> for these children
78cdf0e10cSrcweir            returns an object that supports the service.
79cdf0e10cSrcweir			<type scope="::com::sun::star::table">AccessibleCellView</type>:
80cdf0e10cSrcweir			A child where calling
81cdf0e10cSrcweir            <method scope="::com::sun::star::accessibility"
82cdf0e10cSrcweir            >XAccessibleContext::getAccessibleChild</method>
83cdf0e10cSrcweir			an object that supports this service is returned for
84cdf0e10cSrcweir			every partially visible cell in this table.
85cdf0e10cSrcweir		<p>The following rules apply to the children order.</p>
86cdf0e10cSrcweir		<ul>
87cdf0e10cSrcweir			<li>All the children are cells. The order of this cells is to
88cdf0e10cSrcweir			the order on the screen. This means that the first cell is the
89cdf0e10cSrcweir			cell in the left top edge of the table and the last one is the
90cdf0e10cSrcweir			cell in the right bottom edge of the table. The second is the
91cdf0e10cSrcweir			cell in the first row and second xolumn and so on.</li>
92cdf0e10cSrcweir		</ul>
93cdf0e10cSrcweir		<li>The description is ???.</li>
94cdf0e10cSrcweir		<li>The name is the given table name and a number to make it non-ambiguous.</li>
95cdf0e10cSrcweir		<li>The role is <const scope="::com::sun::star::accessibility"
96cdf0e10cSrcweir            >AccessibleRole::TABLE</const></li>
97cdf0e10cSrcweir		<li>In a spreadsheet page preview there are relations between the
98cdf0e10cSrcweir			table and the shapes with an anchor
99cdf0e10cSrcweir			on this table (not with an anchor on a cell in this table).</li>
100cdf0e10cSrcweir		<li>The following states are supported:
101cdf0e10cSrcweir			<ul>
102cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
103cdf0e10cSrcweir                    >AccessibleStateType::DEFUNC</const> is always false if the
104cdf0e10cSrcweir                    table is not deleted, the document is open. Also it is
105cdf0e10cSrcweir                    false if the table was showed in a page preview and the
106*a893be29SPedro Giffuni                    page preview is already opend, otherwise it is true.</li>
107cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
108cdf0e10cSrcweir                    >AccessibleStateType::EDITABLE</const> is false if the
109cdf0e10cSrcweir                    table is showed in a page preview or the table is
110cdf0e10cSrcweir                    protected, otherwise it is true.</li>
111cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
112cdf0e10cSrcweir                    >AccessibleStateType::ENABLED</const> is always true.</li>
113cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
114cdf0e10cSrcweir                    >AccessibleStateType::MULTI_SELECTABLE</const> is false
115cdf0e10cSrcweir                    if the table is showed in a page preview, otherwise it is
116cdf0e10cSrcweir                    true.</li>
117cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
118cdf0e10cSrcweir                    >AccessibleStateType::OPAQUE</const> is false, if the table
119cdf0e10cSrcweir                    has no background color or graphic, otherwise it is
120cdf0e10cSrcweir                    false.</li>
121cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
122cdf0e10cSrcweir                    >AccessibleStateType::SHOWING</const>Is true if the
123cdf0e10cSrcweir                    Bounding Box lies in the Bounding Box of the parent.
124cdf0e10cSrcweir                    Otherwise it is false.</li>
125cdf0e10cSrcweir				<li><const scope="::com::sun::star::accessibility"
126cdf0e10cSrcweir                    >AccessibleStateType::VISIBLE</const>Is always true.</li>
127cdf0e10cSrcweir			</ul>
128cdf0e10cSrcweir		</li>
129cdf0e10cSrcweir	</ul>
130cdf0e10cSrcweir
131cdf0e10cSrcweir	 */
132cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleContext;
133cdf0e10cSrcweir
134cdf0e10cSrcweir	/** This interface gives access to the visibility of the document.
135cdf0e10cSrcweir	*/
136cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleComponent;
137cdf0e10cSrcweir
138cdf0e10cSrcweir	/** This interface gives access to any cell that is at least partially
139cdf0e10cSrcweir		visible on the screen. So this interface gives access to the same
140cdf0e10cSrcweir		things like the XAccessibleContext interface. Therefor it use more
141cdf0e10cSrcweir		usable methods. Also it gives access to some table specific data.
142cdf0e10cSrcweir	 */
143cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleTable;
144cdf0e10cSrcweir
145cdf0e10cSrcweir	/** This interface is for selecting the cells. This interface is optional.
146cdf0e10cSrcweir	 */
147cdf0e10cSrcweir	[optional] interface ::com::sun::star::accessibility::XAccessibleSelection;
148cdf0e10cSrcweir
149cdf0e10cSrcweir	/** This is the interface for listeners */
150cdf0e10cSrcweir	interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
151cdf0e10cSrcweir};
152cdf0e10cSrcweir
153cdf0e10cSrcweir//=============================================================================
154cdf0e10cSrcweir
155cdf0e10cSrcweir}; }; }; };
156cdf0e10cSrcweir
157cdf0e10cSrcweir#endif
158