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_XSheetCellRangeContainer_idl__ 25cdf0e10cSrcweir#define __com_sun_star_sheet_XSheetCellRangeContainer_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__ 28cdf0e10cSrcweir#include <com/sun/star/sheet/XSheetCellRanges.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_table_CellRangeAddress_idl__ 32cdf0e10cSrcweir#include <com/sun/star/table/CellRangeAddress.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_container_NoSuchElementException_idl__ 36cdf0e10cSrcweir#include <com/sun/star/container/NoSuchElementException.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweirmodule com { module sun { module star { module sheet { 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweir/** provides methods to access cell ranges in a collection via index and 46cdf0e10cSrcweir to add and remove cell ranges. 47cdf0e10cSrcweir 48cdf0e10cSrcweir @see com::sun::star::sheet::SheetCellRanges 49cdf0e10cSrcweir */ 50cdf0e10cSrcweirpublished interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges 51cdf0e10cSrcweir{ 52cdf0e10cSrcweir //------------------------------------------------------------------------- 53cdf0e10cSrcweir 54cdf0e10cSrcweir /** adds the given range to the collection of cell ranges. 55cdf0e10cSrcweir 56cdf0e10cSrcweir @param aCellRangeAddress 57cdf0e10cSrcweir contains the address of the new range. 58cdf0e10cSrcweir 59cdf0e10cSrcweir @param bMergeRanges 60cdf0e10cSrcweir defines how the range should be added. To merge the ranges 61cdf0e10cSrcweir takes more time, but the memory usage is lower. 62cdf0e10cSrcweir */ 63cdf0e10cSrcweir void addRangeAddress( 64cdf0e10cSrcweir [in] com::sun::star::table::CellRangeAddress aCellRangeAddress, 65cdf0e10cSrcweir [in] boolean bMergeRanges ); 66cdf0e10cSrcweir 67cdf0e10cSrcweir //------------------------------------------------------------------------- 68cdf0e10cSrcweir 69cdf0e10cSrcweir /** removes the given range from the collection of cell ranges. 70cdf0e10cSrcweir 71cdf0e10cSrcweir @param aCellRangeAddress 72cdf0e10cSrcweir contains the address of the range to be removed. 73cdf0e10cSrcweir 74cdf0e10cSrcweir <p>The specified range must fit exactly to an element of the 75cdf0e10cSrcweir collection. The method does not try to shorten a range.</p> 76cdf0e10cSrcweir 77cdf0e10cSrcweir @throws <type scope="com::sun::star::container">NoSuchElementException</type> 78cdf0e10cSrcweir if the collection does not contain the specified range. 79cdf0e10cSrcweir */ 80cdf0e10cSrcweir void removeRangeAddress( 81cdf0e10cSrcweir [in] com::sun::star::table::CellRangeAddress aCellRangeAddress ) 82cdf0e10cSrcweir raises( com::sun::star::container::NoSuchElementException ); 83cdf0e10cSrcweir 84cdf0e10cSrcweir //------------------------------------------------------------------------- 85cdf0e10cSrcweir 86cdf0e10cSrcweir /** adds the given ranges to the collection of cell ranges. 87cdf0e10cSrcweir 88cdf0e10cSrcweir @param aCellRangeAddresses 89cdf0e10cSrcweir contains a sequence of addresses of all new ranges. 90cdf0e10cSrcweir 91cdf0e10cSrcweir @param bMergeRanges 92cdf0e10cSrcweir defines how the ranges should be added. To merge the ranges 93cdf0e10cSrcweir takes more time, but the memory usage is lower. 94cdf0e10cSrcweir */ 95cdf0e10cSrcweir void addRangeAddresses( 96cdf0e10cSrcweir [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses, 97cdf0e10cSrcweir [in] boolean bMergeRanges ); 98cdf0e10cSrcweir 99cdf0e10cSrcweir //------------------------------------------------------------------------- 100cdf0e10cSrcweir 101cdf0e10cSrcweir /** removes the given ranges from the collection of cell ranges. 102cdf0e10cSrcweir 103cdf0e10cSrcweir @param aCellRangeAddresses 104cdf0e10cSrcweir contains a sequence of addresses of all ranges to be removed. 105cdf0e10cSrcweir 106cdf0e10cSrcweir <p>All specified ranges must fit exactly to elements of the 107cdf0e10cSrcweir collection. The method does not try to shorten ranges.</p> 108cdf0e10cSrcweir 109cdf0e10cSrcweir @throws <type scope="com::sun::star::container">NoSuchElementException</type> 110cdf0e10cSrcweir if the collection does not contain any of the specified ranges. 111cdf0e10cSrcweir */ 112cdf0e10cSrcweir void removeRangeAddresses( 113cdf0e10cSrcweir [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses ) 114cdf0e10cSrcweir raises( com::sun::star::container::NoSuchElementException); 115cdf0e10cSrcweir 116cdf0e10cSrcweir}; 117cdf0e10cSrcweir 118cdf0e10cSrcweir//============================================================================= 119cdf0e10cSrcweir 120cdf0e10cSrcweir}; }; }; }; 121cdf0e10cSrcweir 122cdf0e10cSrcweir#endif 123cdf0e10cSrcweir 124