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_AccessibleSpreadsheetDocumentView_idl__
24#define __com_sun_star_sheet_AccessibleSpreadsheetDocumentView_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_XAccessibleValue_idl__
35#include <com/sun/star/accessibility/XAccessibleValue.idl>
36#endif
37
38#ifndef __com_sun_star_accessibility_XAccessibleText_idl__
39#include <com/sun/star/accessibility/XAccessibleText.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 cell in a text document or in the page preview
58  	of a spreadsheet document. See
59	<type scope="::com::sun::star::sheet">AccessibleCell</type> for cells in
60    the edit view of a spreadsheet.
61    @since OOo 1.1.2
62*/
63published service AccessibleCellView
64{
65	/** This interface gives access to the visible content of a cell in a
66		accessible spreadsheet page preview or accessible text document view.
67	<ul>
68		<li>The parent returned by <method scope="::com::sun::star::accessibility"
69            >XAccessibleContext::getAccessibleParent</method>
70			is the accessible table view.</li>
71		<li>The children returned by
72            <method scope="::com::sun::star::accessibility"
73            >XAccessibleContext::getAccessibleChild</method> all
74			support the interface XAccessible. Calling
75			<method scope="::com::sun::star::accessibility"
76            >XAccessibleContext::getAccessibleContext</method> for these
77            children returns an object that supports the service
78			<type scope="::com::sun::star::text"
79            >AccessibleParagraphView</type>:
80			A child of this kind is returned for every paragraph
81			fragment that is contained in the cell and
82			is at least partially visible. A paragraph fragment is
83			the part of a paragraph that is displayed on a
84			certain page.
85		<li>The name is something like A10 or B23 or so on.</li>
86		<li>The description is the name or the content of the given note.</li>
87		<li>The role is <const scope="::com::sun::star::accessibility"
88            >AccessibleRole::TABLE_CELL</const></li>
89		<li>For spreadsheets, there are relations between the cell and the
90			shapes with an anchor on this cell.</li>
91		<li>The following states are supported:
92			<ul>
93				<li><const scope="::com::sun::star::accessibility"
94                    >AccessibleStateType::DEFUNC</const> is always false if the
95                    cell is showed, otherwise it is true.</li>
96				<li><const scope="::com::sun::star::accessibility"
97                    >AccessibleStateType::EDITABLE</const> is false if the cell
98                    is showed in a page preview or the cell or the table is
99                    protected, otherwise it is true.</li>
100				<li><const scope="::com::sun::star::accessibility"
101                    >AccessibleStateType::ENABLED</const> is always true.</li>
102				<li><const scope="::com::sun::star::accessibility"
103                    >AccessibleStateType::MULTI_LINE</const> is always true in
104                    spreadsheets and false otherwise.</li>
105				<li><const scope="::com::sun::star::accessibility"
106                    >AccessibleStateType::OPAQUE</const> is false if the cell
107                    has no background color or graphic, otherwise it is true.</li>
108				<li><const scope="::com::sun::star::accessibility"
109                    >AccessibleStateType::SELECTABLE</const> is true if the
110                    cell is not showed in a page preview, otherwise is it
111                    false.</li>
112				<li><const scope="::com::sun::star::accessibility"
113                    >AccessibleStateType::SELECTED</const> is true, if the cell
114                    is selected. This is not possible in the page preview.</li>
115				<li><const scope="::com::sun::star::accessibility"
116                    >AccessibleStateType::SHOWING</const>Is true if the
117                    Bounding Box lies in the Bounding Box of the parent.
118                    Otherwise it is false.</li>
119				<li><const scope="::com::sun::star::accessibility"
120                    >AccessibleStateType::TRANSIENT</const>Is true if the cell
121                    is showed in a spreadsheet page preview. Otherwise it is
122                    false.</li>
123				<li><const scope="::com::sun::star::accessibility"
124                    >AccessibleStateType::VISIBLE</const>Is always true.</li>
125			</ul>
126		</li>
127	</ul>
128	 */
129	interface ::com::sun::star::accessibility::XAccessibleContext;
130
131	/** This interface gives access to the visibility of the cell.
132	*/
133	interface ::com::sun::star::accessibility::XAccessibleComponent;
134
135	/** This interface gives access to the value of the cell.
136		Only a readonly access is possible.
137	 */
138	interface ::com::sun::star::accessibility::XAccessibleValue;
139
140	/** This interface is for selecting the text, value or parts of this in the
141		cell. This interface is optional.
142	 */
143	[optional] interface ::com::sun::star::accessibility::XAccessibleSelection;
144
145	/** This is the interface for listeners */
146	[optional] interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
147};
148
149//=============================================================================
150
151}; }; }; };
152
153#endif
154