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_AccessibleCell_idl__
28#define __com_sun_star_sheet_AccessibleCell_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_XAccessibleValue_idl__
39#include <com/sun/star/accessibility/XAccessibleValue.idl>
40#endif
41
42#ifndef __com_sun_star_accessibility_XAccessibleText_idl__
43#include <com/sun/star/accessibility/XAccessibleText.idl>
44#endif
45
46
47//=============================================================================
48
49module com {  module sun {  module star {  module sheet {
50
51//=============================================================================
52
53/** The accessible view of a spreadsheet document
54
55	 @since OOo 1.1.2
56
57 */
58published service AccessibleCell
59{
60	/** This interface gives access to the whole content of the cell.
61
62	<ul>
63		<li>The parent returned by
64            <method scope="::com::sun::star::accessibility"
65            >XAccessibleContext::getAccessibleParent</method>
66			is the accessible spreadsheet.</li>
67		<li>This object has no children.</li>
68		<li>The description is ???.</li>
69		<li>The name is something like A10 or B23 or so on.</li>
70		<li>The role is <const scope="::com::sun::star::accessibility"
71            >AccessibleRole::TABLE_CELL</const></li>
72		<li>There are relations between the cell and the shapes with an anchor
73			on this cell.</li>
74		<li>The following states are supported:
75			<ul>
76				<li><const scope="::com::sun::star::accessibility"
77                    >AccessibleStateType::DEFUNC</const> is always false if the
78                    parent table is showed, otherwise it is true.</li>
79				<li><const scope="::com::sun::star::accessibility"
80                    >AccessibleStateType::EDITABLE</const> is false if the cell
81                    or the table is protected, otherwise it is true.</li>
82				<li><const scope="::com::sun::star::accessibility"
83                    >AccessibleStateType::ENABLED</const> is always true.</li>
84				<li><const scope="::com::sun::star::accessibility"
85                    >AccessibleStateType::MULTILINE</const> is always true.</li>
86				<li><const scope="::com::sun::star::accessibility"
87                    >AccessibleStateType::MULTISELECTABLE</const> is always
88                    true.</li>
89				<li><const scope="::com::sun::star::accessibility"
90                    >AccessibleStateType::OPAQUE</const> is false if the cell
91                    has no background color or graphic, otherwise it is
92                    true.</li>
93				<li><const scope="::com::sun::star::accessibility"
94                    >AccessibleStateType::RESIZEABLE</const> is false if the
95                    table is protected, otherwise is it true.</li>
96				<li><const scope="::com::sun::star::accessibility"
97                    >AccessibleStateType::SELECTABLE</const> is always
98                    true.</li>
99				<li><const scope="::com::sun::star::accessibility"
100                    >AccessibleStateType::SELECTED</const> is true, if the
101                    cell is selected.</li>
102				<li><const scope="::com::sun::star::accessibility"
103                    >AccessibleStateType::TRANSIENT</const> is always true.</li>
104				<li><const scope="::com::sun::star::accessibility"
105                    >AccessibleStateType::SHOWING</const>Is true if the
106                    Bounding Box lies in Bounding Box of the parent. Otherwise
107                    it is false.</li>
108				<li><const scope="::com::sun::star::accessibility"
109                    >AccessibleStateType::VISIBLE</const>Is false if the
110                    column/row with this cell is filtered or hidden.
111                    Otherwise is true.</li>
112			</ul>
113		</li>
114	</ul>
115	 */
116	interface ::com::sun::star::accessibility::XAccessibleContext;
117
118	/** This interface gives access to the visibility of the cell.
119	*/
120	interface ::com::sun::star::accessibility::XAccessibleComponent;
121
122	/** This interface gives access to the value of the cell.
123	 */
124	interface ::com::sun::star::accessibility::XAccessibleValue;
125
126	/** This interface gives access to the text representation of the cell content.
127	 */
128	interface ::com::sun::star::accessibility::XAccessibleText;
129};
130
131//=============================================================================
132
133}; }; }; };
134
135#endif
136