xref: /AOO41X/main/offapi/com/sun/star/sheet/XSubTotalField.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_XSubTotalField_idl__
25#define __com_sun_star_sheet_XSubTotalField_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 settings of a field in a subtotal descriptor.
42
43    @see com::sun::star::sheet::SubTotalField
44    @see com::sun::star::sheet::SubTotalDescriptor
45 */
46published interface XSubTotalField: com::sun::star::uno::XInterface
47{
48    //-------------------------------------------------------------------------
49
50    /** returns the column by which entries are grouped.
51     */
52    long getGroupColumn();
53
54    //-------------------------------------------------------------------------
55
56    /** sets the column by which entries are grouped.
57     */
58    void setGroupColumn( [in] long nGroupColumn );
59
60    //-------------------------------------------------------------------------
61
62    /** returns the definitions of which columns should have subtotals
63        added to them.
64     */
65    sequence< com::sun::star::sheet::SubTotalColumn > getSubTotalColumns();
66
67    //-------------------------------------------------------------------------
68
69    /** sets the definitions of which columns should have subtotals
70        added to them.
71     */
72    void setSubTotalColumns(
73        [in] sequence< com::sun::star::sheet::SubTotalColumn >
74            aSubTotalColumns );
75
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83
84