summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XCellSeries.idl
blob: 72a15a8416ddda660414ca95587b060a2cc92739 (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
106
107
108
109
110
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_XCellSeries_idl__
#define __com_sun_star_sheet_XCellSeries_idl__

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

#ifndef __com_sun_star_sheet_FillDirection_idl__
#include <com/sun/star/sheet/FillDirection.idl>
#endif

#ifndef __com_sun_star_sheet_FillMode_idl__
#include <com/sun/star/sheet/FillMode.idl>
#endif

#ifndef __com_sun_star_sheet_FillDateMode_idl__
#include <com/sun/star/sheet/FillDateMode.idl>
#endif

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

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

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

/** provides methods to fill out a cell range automatically with values
    based on a start value, step count and fill mode.

    @see com::sun::star::sheet::SheetCellRange
 */
published interface XCellSeries: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** fills all cells in the range based on the specified settings.

        @param nFillDirection
            specifies the direction to fill the rows/columns of the range.

        @param nFillMode
             specifies the type of the series.

        @param nFillDateMode
             specifies the calculation mode for date values.

        @param fStep
            contains the value used to increase/decrease the series values.

        @param fEndValue
            contains the threshold value on which the calculation of the
            current series stops.
     */
    void fillSeries(
            [in] com::sun::star::sheet::FillDirection nFillDirection,
            [in] com::sun::star::sheet::FillMode nFillMode,
            [in] com::sun::star::sheet::FillDateMode nFillDateMode,
            [in] double fStep,
            [in] double fEndValue );

    //-------------------------------------------------------------------------

    /** fills all cells in the range in a way that is specified by the
        first cell(s) in the range.

        @param nFillDirection
            specifies the direction to fill the rows/columns of the range.

        @param nSourceCount
            contains the number of cells in each row/column used to
            constitute the fill algorithm.
     */
    void fillAuto(
            [in] com::sun::star::sheet::FillDirection nFillDirection,
            [in] long nSourceCount );

};

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

}; }; }; };

#endif