summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/table/XCellRange.idl
blob: 4c4df4f52732797056ddda2dd68457f44a357a84 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_table_XCellRange_idl__
#define __com_sun_star_table_XCellRange_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif

#ifndef __com_sun_star_table_XCell_idl__
#include <com/sun/star/table/XCell.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module table {

//=============================================================================

/** provides access to the cells or to sub-ranges of a cell range.

    @see com::sun::star::table::CellRange
 */
published interface XCellRange: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** Returns a single cell within the range.

        @param nColumn
            is the column index of the cell inside the range.

        @param nRow
            is the row index of the cell inside the range.

        @returns
            the specified cell.

        @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
            if an index is outside the dimensions of this range.

        @see com::sun::star::table::Cell
     */
    com::sun::star::table::XCell getCellByPosition(
            [in] long nColumn,
            [in] long nRow )
        raises( com::sun::star::lang::IndexOutOfBoundsException );

    //-------------------------------------------------------------------------

    /** Returns a sub-range of cells within the range.

        @param nLeft
            is the column index of the first cell inside the range.

        @param nTop
            is the row index of the first cell inside the range.

        @param nRight
            is the column index of the last cell inside the range.

        @param nBottom
            is the row index of the last cell inside the range.

        @returns
            the specified cell range.

        @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
            if an index is outside the dimensions of this range.

        @see com::sun::star::table::CellRange
     */
    com::sun::star::table::XCellRange getCellRangeByPosition(
            [in] long nLeft,
            [in] long nTop,
            [in] long nRight,
            [in] long nBottom )
        raises( com::sun::star::lang::IndexOutOfBoundsException );

    //-------------------------------------------------------------------------

    /** Returns a sub-range of cells within the range.

        <p>The sub-range is specified by its name. The format of the range
        name is dependent of the context of the table. In spreadsheets valid
        names may be "A1:C5" or "$B$2" or even defined names for cell ranges
        such as "MySpecialCell".</p>

        @param aRange
            the name of the sub-range.

        @returns
            the specified cell range.

        @see com::sun::star::table::CellRange
     */
    com::sun::star::table::XCellRange getCellRangeByName( [in] string aRange );

};

//=============================================================================

}; }; }; };

#endif