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