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_XConsolidatable_idl__
29#define __com_sun_star_sheet_XConsolidatable_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__
36#include <com/sun/star/sheet/XConsolidationDescriptor.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module sheet {
42
43//=============================================================================
44
45/** provides methods to consolidate ranges in a spreadsheet document.
46
47	<p>Consolidation combines the cells of multiple cell ranges, using a
48	specific function.</p>
49
50	@deprecated
51 */
52published interface XConsolidatable: com::sun::star::uno::XInterface
53{
54	//-------------------------------------------------------------------------
55
56	/** creates a consolidation descriptor.
57
58		@param bEmpty
59			<TRUE/> leaves the descriptor empty, <FALSE/> fills it with
60			the settings from the last consolidation action.
61
62		@see com::sun::star::sheet::ConsolidationDescriptor
63	 */
64	com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor(
65			[in] boolean bEmpty );
66
67	//-------------------------------------------------------------------------
68
69	/** consolidates data from several cell ranges, using the settings
70		in the passed descriptor.
71
72		@param xDescriptor
73			the descriptor used to perform the consolidation.
74
75		@see com::sun::star::sheet::ConsolidationDescriptor
76	 */
77	void consolidate(
78			[in] com::sun::star::sheet::XConsolidationDescriptor xDescriptor );
79
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87
88