1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XConsolidatable_idl__
25#define __com_sun_star_sheet_XConsolidatable_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__
32#include <com/sun/star/sheet/XConsolidationDescriptor.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides methods to consolidate ranges in a spreadsheet document.
42
43	<p>Consolidation combines the cells of multiple cell ranges, using a
44	specific function.</p>
45
46	@deprecated
47 */
48published interface XConsolidatable: com::sun::star::uno::XInterface
49{
50	//-------------------------------------------------------------------------
51
52	/** creates a consolidation descriptor.
53
54		@param bEmpty
55			<TRUE/> leaves the descriptor empty, <FALSE/> fills it with
56			the settings from the last consolidation action.
57
58		@see com::sun::star::sheet::ConsolidationDescriptor
59	 */
60	com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor(
61			[in] boolean bEmpty );
62
63	//-------------------------------------------------------------------------
64
65	/** consolidates data from several cell ranges, using the settings
66		in the passed descriptor.
67
68		@param xDescriptor
69			the descriptor used to perform the consolidation.
70
71		@see com::sun::star::sheet::ConsolidationDescriptor
72	 */
73	void consolidate(
74			[in] com::sun::star::sheet::XConsolidationDescriptor xDescriptor );
75
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83
84