1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XCellRangesAccess_idl__ 25cdf0e10cSrcweir#define __com_sun_star_sheet_XCellRangesAccess_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 32cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 36cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir#ifndef __com_sun_star_table_XCell_idl__ 40cdf0e10cSrcweir#include <com/sun/star/table/XCell.idl> 41cdf0e10cSrcweir#endif 42cdf0e10cSrcweir 43cdf0e10cSrcweir#ifndef __com_sun_star_table_XCellRange_idl__ 44cdf0e10cSrcweir#include <com/sun/star/table/XCellRange.idl> 45cdf0e10cSrcweir#endif 46cdf0e10cSrcweir 47cdf0e10cSrcweir//============================================================================= 48cdf0e10cSrcweir 49cdf0e10cSrcweirmodule com { module sun { module star { module sheet { 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir 53cdf0e10cSrcweir/** provides access to the cells or to sub-ranges of all sheets. 54cdf0e10cSrcweir 55cdf0e10cSrcweir @see com::sun::star::sheet::Spreadsheets 56cdf0e10cSrcweir */ 57cdf0e10cSrcweirpublished interface XCellRangesAccess: com::sun::star::uno::XInterface 58cdf0e10cSrcweir{ 59cdf0e10cSrcweir //------------------------------------------------------------------------- 60cdf0e10cSrcweir 61cdf0e10cSrcweir /** Returns a single cell within the range. 62cdf0e10cSrcweir 63cdf0e10cSrcweir @param nColumn 64cdf0e10cSrcweir is the column index of the cell inside the sheet. 65cdf0e10cSrcweir 66cdf0e10cSrcweir @param nRow 67cdf0e10cSrcweir is the row index of the cell inside the sheet. 68cdf0e10cSrcweir 69cdf0e10cSrcweir @param nSheet 70cdf0e10cSrcweir is the sheet index of the sheet inside the document. 71cdf0e10cSrcweir 72cdf0e10cSrcweir @returns 73cdf0e10cSrcweir the specified cell. 74cdf0e10cSrcweir 75cdf0e10cSrcweir @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type> 76cdf0e10cSrcweir if an index is outside the dimensions of this range. 77cdf0e10cSrcweir 78cdf0e10cSrcweir @see com::sun::star::table::Cell 79cdf0e10cSrcweir */ 80cdf0e10cSrcweir com::sun::star::table::XCell getCellByPosition( 81cdf0e10cSrcweir [in] long nColumn, 82cdf0e10cSrcweir [in] long nRow, 83cdf0e10cSrcweir [in] long nSheet ) 84cdf0e10cSrcweir raises( com::sun::star::lang::IndexOutOfBoundsException ); 85cdf0e10cSrcweir 86cdf0e10cSrcweir //------------------------------------------------------------------------- 87cdf0e10cSrcweir 88cdf0e10cSrcweir /** Returns a sub-range of cells within the range. 89cdf0e10cSrcweir 90cdf0e10cSrcweir @param nLeft 91cdf0e10cSrcweir is the column index of the first cell inside the range. 92cdf0e10cSrcweir 93cdf0e10cSrcweir @param nTop 94cdf0e10cSrcweir is the row index of the first cell inside the range. 95cdf0e10cSrcweir 96cdf0e10cSrcweir @param nRight 97cdf0e10cSrcweir is the column index of the last cell inside the range. 98cdf0e10cSrcweir 99cdf0e10cSrcweir @param nBottom 100cdf0e10cSrcweir is the row index of the last cell inside the range. 101cdf0e10cSrcweir 102cdf0e10cSrcweir @param nSheet 103cdf0e10cSrcweir is the sheet index of the sheet inside the document. 104cdf0e10cSrcweir 105cdf0e10cSrcweir @returns 106cdf0e10cSrcweir the specified cell range. 107cdf0e10cSrcweir 108cdf0e10cSrcweir @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type> 109cdf0e10cSrcweir if an index is outside the dimensions of this range. 110cdf0e10cSrcweir 111cdf0e10cSrcweir @see com::sun::star::table::CellRange 112cdf0e10cSrcweir */ 113cdf0e10cSrcweir com::sun::star::table::XCellRange getCellRangeByPosition( 114cdf0e10cSrcweir [in] long nLeft, 115cdf0e10cSrcweir [in] long nTop, 116cdf0e10cSrcweir [in] long nRight, 117cdf0e10cSrcweir [in] long nBottom, 118cdf0e10cSrcweir [in] long nSheet ) 119cdf0e10cSrcweir raises( com::sun::star::lang::IndexOutOfBoundsException ); 120cdf0e10cSrcweir 121cdf0e10cSrcweir //------------------------------------------------------------------------- 122cdf0e10cSrcweir 123cdf0e10cSrcweir /** Returns a sub-range of cells within the range. 124cdf0e10cSrcweir 125cdf0e10cSrcweir <p>The sub-range is specified by its name. The format of the range 126cdf0e10cSrcweir name is dependent of the context of the table. In spreadsheets valid 127cdf0e10cSrcweir names may be "Sheet1.A1:C5" or "$Sheet1.$B$2" or even defined names for cell ranges 128cdf0e10cSrcweir such as "MySpecialCell".</p> 129cdf0e10cSrcweir 130cdf0e10cSrcweir @param aRange 131cdf0e10cSrcweir the name of the sub-range. 132cdf0e10cSrcweir 133cdf0e10cSrcweir @returns 134cdf0e10cSrcweir the specified cell ranges. 135cdf0e10cSrcweir 136cdf0e10cSrcweir @see com::sun::star::table::CellRange 137cdf0e10cSrcweir */ 138cdf0e10cSrcweir sequence <com::sun::star::table::XCellRange> getCellRangesByName( [in] string aRange ) 139cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 140cdf0e10cSrcweir 141cdf0e10cSrcweir}; 142cdf0e10cSrcweir 143cdf0e10cSrcweir//============================================================================= 144cdf0e10cSrcweir 145cdf0e10cSrcweir}; }; }; }; 146cdf0e10cSrcweir 147cdf0e10cSrcweir#endif 148cdf0e10cSrcweir 149