1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 *   Licensed to the Apache Software Foundation (ASF) under one or more
12 *   contributor license agreements. See the NOTICE file distributed
13 *   with this work for additional information regarding copyright
14 *   ownership. The ASF licenses this file to you under the Apache
15 *   License, Version 2.0 (the "License"); you may not use this file
16 *   except in compliance with the License. You may obtain a copy of
17 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__
21#define __com_sun_star_sheet_XSubTotalDescriptor_idl__
22
23#include <com/sun/star/uno/XInterface.idl>
24#include <com/sun/star/sheet/SubTotalColumn.idl>
25
26
27module com {  module sun {  module star {  module sheet {
28
29
30/** provides access to the collection of subtotal fields in a subtotal
31    descriptor.
32
33    @see com::sun::star::sheet::SubTotalDescriptor
34 */
35published interface XSubTotalDescriptor: com::sun::star::uno::XInterface
36{
37
38    /** adds a subtotal field definition to the descriptor.
39
40        @param aSubTotalColumns
41            a sequence of all columns used to calculate subtotal values.
42
43        @param nGroupColumn
44            specifies which column of the source range is used to group the
45            contents of the source data.
46     */
47    void addNew(
48        [in] sequence< com::sun::star::sheet::SubTotalColumn > aSubTotalColumns,
49        [in] long nGroupColumn );
50
51
52    /** removes all subtotal field definitions from the descriptor.
53     */
54    void clear();
55
56};
57
58
59}; }; }; };
60
61#endif
62
63/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
64