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_XSubTotalCalculatable_idl__
25#define __com_sun_star_sheet_XSubTotalCalculatable_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_XSubTotalDescriptor_idl__
32#include <com/sun/star/sheet/XSubTotalDescriptor.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** contains methods to handle a subtotal descriptor.
42
43	<p>The subtotal descriptor provides properties to set up the subtotal
44	function.</p>
45
46	@see com::sun::star::sheet::SheetCellRange
47	@see com::sun::star::sheet::SubTotalDescriptor
48 */
49published interface XSubTotalCalculatable: com::sun::star::uno::XInterface
50{
51	//-------------------------------------------------------------------------
52
53	/** creates a subtotal descriptor.
54
55		@param bEmpty
56			if set to <TRUE/>, creates an empty descriptor. If set to
57			<FALSE/>, fills the descriptor with previous settings of the
58			current object (i.e. a database range).
59	 */
60	com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor(
61			[in] boolean bEmpty );
62
63	//-------------------------------------------------------------------------
64
65	/** creates subtotals using the settings of the passed descriptor.
66
67		@param xDescriptor
68			the subtotal descriptor with the settings used for the subtotal
69			operation.
70
71		@param bReplace
72			if set to <TRUE/>, replaces previous subtotal results.
73	 */
74	void applySubTotals(
75			[in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor,
76			[in] boolean bReplace );
77
78	//-------------------------------------------------------------------------
79
80	/** removes the subtotals from the current object.
81	 */
82	void removeSubTotals();
83
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91
92