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_XSheetCellRanges_idl__ 29#define __com_sun_star_sheet_XSheetCellRanges_idl__ 30 31#ifndef __com_sun_star_container_XIndexAccess_idl__ 32#include <com/sun/star/container/XIndexAccess.idl> 33#endif 34 35#ifndef __com_sun_star_container_XEnumerationAccess_idl__ 36#include <com/sun/star/container/XEnumerationAccess.idl> 37#endif 38 39#ifndef __com_sun_star_table_CellRangeAddress_idl__ 40#include <com/sun/star/table/CellRangeAddress.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 other helper methods. 51 52 @see com::sun::star::sheet::SheetCellRanges 53 */ 54published interface XSheetCellRanges: com::sun::star::container::XIndexAccess 55{ 56 //------------------------------------------------------------------------- 57 58 /** returns the collection of all used cells. 59 60 @see com::sun::star::sheet::Cells 61 */ 62 com::sun::star::container::XEnumerationAccess getCells(); 63 64 //------------------------------------------------------------------------- 65 66 /** creates a string with addresses of all contained cell ranges. 67 68 <p>The range addresses are separated with semicolons. For instance 69 the string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p> 70 71 @returns 72 a string containing the addresses of all cell ranges. 73 */ 74 string getRangeAddressesAsString(); 75 76 //------------------------------------------------------------------------- 77 78 /** creates a sequence with addresses of all contained cell ranges. 79 80 @returns 81 a sequence with the addresses of all cell ranges. 82 */ 83 sequence<com::sun::star::table::CellRangeAddress> getRangeAddresses(); 84 85}; 86 87//============================================================================= 88 89}; }; }; }; 90 91#endif 92 93