1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir
28*cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__
29*cdf0e10cSrcweir#define __com_sun_star_sheet_XSheetCellRanges_idl__
30*cdf0e10cSrcweir
31*cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexAccess_idl__
32*cdf0e10cSrcweir#include <com/sun/star/container/XIndexAccess.idl>
33*cdf0e10cSrcweir#endif
34*cdf0e10cSrcweir
35*cdf0e10cSrcweir#ifndef __com_sun_star_container_XEnumerationAccess_idl__
36*cdf0e10cSrcweir#include <com/sun/star/container/XEnumerationAccess.idl>
37*cdf0e10cSrcweir#endif
38*cdf0e10cSrcweir
39*cdf0e10cSrcweir#ifndef __com_sun_star_table_CellRangeAddress_idl__
40*cdf0e10cSrcweir#include <com/sun/star/table/CellRangeAddress.idl>
41*cdf0e10cSrcweir#endif
42*cdf0e10cSrcweir
43*cdf0e10cSrcweir//=============================================================================
44*cdf0e10cSrcweir
45*cdf0e10cSrcweirmodule com {  module sun {  module star {  module sheet {
46*cdf0e10cSrcweir
47*cdf0e10cSrcweir//=============================================================================
48*cdf0e10cSrcweir
49*cdf0e10cSrcweir/** provides methods to access cell ranges in a collection via index and
50*cdf0e10cSrcweir	other helper methods.
51*cdf0e10cSrcweir
52*cdf0e10cSrcweir	@see com::sun::star::sheet::SheetCellRanges
53*cdf0e10cSrcweir */
54*cdf0e10cSrcweirpublished interface XSheetCellRanges: com::sun::star::container::XIndexAccess
55*cdf0e10cSrcweir{
56*cdf0e10cSrcweir	//-------------------------------------------------------------------------
57*cdf0e10cSrcweir
58*cdf0e10cSrcweir	/** returns the collection of all used cells.
59*cdf0e10cSrcweir
60*cdf0e10cSrcweir		@see com::sun::star::sheet::Cells
61*cdf0e10cSrcweir	 */
62*cdf0e10cSrcweir	com::sun::star::container::XEnumerationAccess getCells();
63*cdf0e10cSrcweir
64*cdf0e10cSrcweir	//-------------------------------------------------------------------------
65*cdf0e10cSrcweir
66*cdf0e10cSrcweir	/** creates a string with addresses of all contained cell ranges.
67*cdf0e10cSrcweir
68*cdf0e10cSrcweir		<p>The range addresses are separated with semicolons. For instance
69*cdf0e10cSrcweir		the string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p>
70*cdf0e10cSrcweir
71*cdf0e10cSrcweir		@returns
72*cdf0e10cSrcweir			a string containing the addresses of all cell ranges.
73*cdf0e10cSrcweir	 */
74*cdf0e10cSrcweir	string getRangeAddressesAsString();
75*cdf0e10cSrcweir
76*cdf0e10cSrcweir	//-------------------------------------------------------------------------
77*cdf0e10cSrcweir
78*cdf0e10cSrcweir	/** creates a sequence with addresses of all contained cell ranges.
79*cdf0e10cSrcweir
80*cdf0e10cSrcweir		@returns
81*cdf0e10cSrcweir			a sequence with the addresses of all cell ranges.
82*cdf0e10cSrcweir	 */
83*cdf0e10cSrcweir	sequence<com::sun::star::table::CellRangeAddress> getRangeAddresses();
84*cdf0e10cSrcweir
85*cdf0e10cSrcweir};
86*cdf0e10cSrcweir
87*cdf0e10cSrcweir//=============================================================================
88*cdf0e10cSrcweir
89*cdf0e10cSrcweir}; }; }; };
90*cdf0e10cSrcweir
91*cdf0e10cSrcweir#endif
92*cdf0e10cSrcweir
93