1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XCellRangesAccess.idl,v $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
31 #ifndef __com_sun_star_sheet_XCellRangesAccess_idl__
32 #define __com_sun_star_sheet_XCellRangesAccess_idl__
34 #ifndef __com_sun_star_uno_XInterface_idl__
35 #include
<com
/sun
/star
/uno
/XInterface.idl
>
38 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
39 #include
<com
/sun
/star
/lang
/IndexOutOfBoundsException.idl
>
42 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
43 #include
<com
/sun
/star
/lang
/IllegalArgumentException.idl
>
46 #ifndef __com_sun_star_table_XCell_idl__
47 #include
<com
/sun
/star
/table
/XCell.idl
>
50 #ifndef __com_sun_star_table_XCellRange_idl__
51 #include
<com
/sun
/star
/table
/XCellRange.idl
>
54 //=============================================================================
56 module com
{ module sun
{ module star
{ module sheet
{
58 //=============================================================================
60 /** provides access to the cells or to sub-ranges of all sheets.
62 @see com::sun::star::sheet::Spreadsheets
64 published
interface XCellRangesAccess
: com
::sun
::star
::uno
::XInterface
66 //-------------------------------------------------------------------------
68 /** Returns a single cell within the range.
71 is the column index of the cell inside the sheet.
74 is the row index of the cell inside the sheet.
77 is the sheet index of the sheet inside the document.
82 @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
83 if an index is outside the dimensions of this range.
85 @see com::sun::star::table::Cell
87 com
::sun
::star
::table
::XCell getCellByPosition
(
91 raises
( com
::sun
::star
::lang
::IndexOutOfBoundsException
);
93 //-------------------------------------------------------------------------
95 /** Returns a sub-range of cells within the range.
98 is the column index of the first cell inside the range.
101 is the row index of the first cell inside the range.
104 is the column index of the last cell inside the range.
107 is the row index of the last cell inside the range.
110 is the sheet index of the sheet inside the document.
113 the specified cell range.
115 @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
116 if an index is outside the dimensions of this range.
118 @see com::sun::star::table::CellRange
120 com
::sun
::star
::table
::XCellRange getCellRangeByPosition
(
126 raises
( com
::sun
::star
::lang
::IndexOutOfBoundsException
);
128 //-------------------------------------------------------------------------
130 /** Returns a sub-range of cells within the range.
132 <p>The sub-range is specified by its name. The format of the range
133 name is dependent of the context of the table. In spreadsheets valid
134 names may be "Sheet1.A1:C5" or "$Sheet1.$B$2" or even defined names for cell ranges
135 such as "MySpecialCell".</p>
138 the name of the sub-range.
141 the specified cell ranges.
143 @see com::sun::star::table::CellRange
145 sequence
<com
::sun
::star
::table
::XCellRange
> getCellRangesByName
( [in] string aRange
)
146 raises
( com
::sun
::star
::lang
::IllegalArgumentException
);
150 //=============================================================================