summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/XCellRangeFormula.idl
blob: 0b8626c69e70c0c35bb5df88b6cbb800793c0f80 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_sheet_XCellRangeFormula_idl__
#define __com_sun_star_sheet_XCellRangeFormula_idl__

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


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


/** allows to get and set cell contents (values, text or formulas)
    for a cell range.

    <p>The outer sequence represents the rows and the inner sequence
    the columns of the array.</p>

    @since OOo 1.1.2
 */

published interface XCellRangeFormula: com::sun::star::uno::XInterface
{
    /** gets an array from the contents of the cell range.

        <p>Each element of the result contains the same string that
        would be returned by
        com::sun::star::table::XCell::getFormula()
        for the corresponding cell.</p>
     */
    sequence< sequence< string > > getFormulaArray();

    /** fills the cell range with values from an array.

        <p>The size of the array must be the same as the size of the cell
        range. Each element of the array is interpreted the same way as
        the argument to a
        com::sun::star::table::XCell::setFormula()
        call for the corresponding cell.</p>

        @throws com::sun::star::uno::RuntimeException
            If the size of the array is different from the current size.
     */
    void setFormulaArray( [in] sequence< sequence< string > > aArray );
};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */