1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28#ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__ 29#define __com_sun_star_sheet_XSheetCellRangeContainer_idl__ 30 31#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__ 32#include <com/sun/star/sheet/XSheetCellRanges.idl> 33#endif 34 35#ifndef __com_sun_star_table_CellRangeAddress_idl__ 36#include <com/sun/star/table/CellRangeAddress.idl> 37#endif 38 39#ifndef __com_sun_star_container_NoSuchElementException_idl__ 40#include <com/sun/star/container/NoSuchElementException.idl> 41#endif 42 43//============================================================================= 44 45module com { module sun { module star { module sheet { 46 47//============================================================================= 48 49/** provides methods to access cell ranges in a collection via index and 50 to add and remove cell ranges. 51 52 @see com::sun::star::sheet::SheetCellRanges 53 */ 54published interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges 55{ 56 //------------------------------------------------------------------------- 57 58 /** adds the given range to the collection of cell ranges. 59 60 @param aCellRangeAddress 61 contains the address of the new range. 62 63 @param bMergeRanges 64 defines how the range should be added. To merge the ranges 65 takes more time, but the memory usage is lower. 66 */ 67 void addRangeAddress( 68 [in] com::sun::star::table::CellRangeAddress aCellRangeAddress, 69 [in] boolean bMergeRanges ); 70 71 //------------------------------------------------------------------------- 72 73 /** removes the given range from the collection of cell ranges. 74 75 @param aCellRangeAddress 76 contains the address of the range to be removed. 77 78 <p>The specified range must fit exactly to an element of the 79 collection. The method does not try to shorten a range.</p> 80 81 @throws <type scope="com::sun::star::container">NoSuchElementException</type> 82 if the collection does not contain the specified range. 83 */ 84 void removeRangeAddress( 85 [in] com::sun::star::table::CellRangeAddress aCellRangeAddress ) 86 raises( com::sun::star::container::NoSuchElementException ); 87 88 //------------------------------------------------------------------------- 89 90 /** adds the given ranges to the collection of cell ranges. 91 92 @param aCellRangeAddresses 93 contains a sequence of addresses of all new ranges. 94 95 @param bMergeRanges 96 defines how the ranges should be added. To merge the ranges 97 takes more time, but the memory usage is lower. 98 */ 99 void addRangeAddresses( 100 [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses, 101 [in] boolean bMergeRanges ); 102 103 //------------------------------------------------------------------------- 104 105 /** removes the given ranges from the collection of cell ranges. 106 107 @param aCellRangeAddresses 108 contains a sequence of addresses of all ranges to be removed. 109 110 <p>All specified ranges must fit exactly to elements of the 111 collection. The method does not try to shorten ranges.</p> 112 113 @throws <type scope="com::sun::star::container">NoSuchElementException</type> 114 if the collection does not contain any of the specified ranges. 115 */ 116 void removeRangeAddresses( 117 [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses ) 118 raises( com::sun::star::container::NoSuchElementException); 119 120}; 121 122//============================================================================= 123 124}; }; }; }; 125 126#endif 127 128