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_XSubTotalDescriptor_idl__
25#define __com_sun_star_sheet_XSubTotalDescriptor_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_SubTotalColumn_idl__
32#include <com/sun/star/sheet/SubTotalColumn.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides access to the collection of subtotal fields in a subtotal
42	descriptor.
43
44	@see com::sun::star::sheet::SubTotalDescriptor
45 */
46published interface XSubTotalDescriptor: com::sun::star::uno::XInterface
47{
48	//-------------------------------------------------------------------------
49
50	/** adds a subtotal field definition to the descriptor.
51
52		@param aSubTotalColumns
53			a sequence of all columns used to calculate subtotal values.
54
55		@param nGroupColumn
56			specifies which column of the source range is used to group the
57			contents of the source data.
58	 */
59	void addNew(
60		[in] sequence< com::sun::star::sheet::SubTotalColumn > aSubTotalColumns,
61		[in] long nGroupColumn );
62
63	//-------------------------------------------------------------------------
64
65	/** removes all subtotal field definitions from the descriptor.
66	 */
67	void clear();
68
69};
70
71//=============================================================================
72
73}; }; }; };
74
75#endif
76
77