summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XMultipleOperation.idl
blob: 8d08b2ed85de6997b2088fe62dd73fe1b130a4bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XMultipleOperation.idl,v $
 * $Revision: 1.8 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XMultipleOperation_idl__
#define __com_sun_star_sheet_XMultipleOperation_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif

#ifndef __com_sun_star_sheet_TableOperationMode_idl__
#include <com/sun/star/sheet/TableOperationMode.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides a method to apply a Multiple Operations Table to the
    cell range.
 */
published interface XMultipleOperation: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** creates a table of formulas (a "Multiple Operations Table").

        <p>The specified formulas are repeated, with references to the
        specified cells replaced by references to values in the first
        column and/or row of the range.</p>

        @param aFormulaRange
            the range that contains formula cells (modes
            <const>TableOperationMode::ROW</const> or
            <const>TableOperationMode::COLUMN</const>) or a single formula
            cell (mode <const>TableOperationMode::BOTH</const>).

        @param nMode
            specifies the calculation mode to fill the cells.

        @param aColumnCell
            contains the address of the cell that is referenced by
            formulas in a row (mode <const>TableOperationMode::ROW</const>)
            or by the formula cell used for two value series (mode
            <const>TableOperationMode::BOTH</const>). This parameter is not
            used if mode is <const>TableOperationMode::COLUMN</const>.

        @param aRowCell
            contains the address of the cell that is referenced by
            formulas in a column (mode <const>TableOperationMode::COLUMN</const>)
            or by the formula cell used for two value series (mode
            <const>TableOperationMode::BOTH</const>). This parameter is not
            used if mode is <const>TableOperationMode::ROW</const>.
     */
    void setTableOperation(
            [in] com::sun::star::table::CellRangeAddress aFormulaRange,
            [in] com::sun::star::sheet::TableOperationMode nMode,
            [in] com::sun::star::table::CellAddress aColumnCell,
            [in] com::sun::star::table::CellAddress aRowCell );

};

//=============================================================================

}; }; }; };

#endif