xref: /AOO41X/main/offapi/com/sun/star/sheet/XCellSeries.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_XCellSeries_idl__
25#define __com_sun_star_sheet_XCellSeries_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_FillDirection_idl__
32#include <com/sun/star/sheet/FillDirection.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_FillMode_idl__
36#include <com/sun/star/sheet/FillMode.idl>
37#endif
38
39#ifndef __com_sun_star_sheet_FillDateMode_idl__
40#include <com/sun/star/sheet/FillDateMode.idl>
41#endif
42
43//=============================================================================
44
45module com {  module sun {  module star {  module sheet {
46
47//=============================================================================
48
49/** provides methods to fill out a cell range automatically with values
50    based on a start value, step count and fill mode.
51
52    @see com::sun::star::sheet::SheetCellRange
53 */
54published interface XCellSeries: com::sun::star::uno::XInterface
55{
56    //-------------------------------------------------------------------------
57
58    /** fills all cells in the range based on the specified settings.
59
60        @param nFillDirection
61            specifies the direction to fill the rows/columns of the range.
62
63        @param nFillMode
64            specifies the type of the series.
65
66        @param nFillDateMode
67            specifies the calculation mode for date values.
68
69        @param fStep
70            contains the value used to increase/decrease the series values.
71
72        @param fEndValue
73            contains the threshold value on which the calculation of the
74            current series stops.
75     */
76    void fillSeries(
77            [in] com::sun::star::sheet::FillDirection nFillDirection,
78            [in] com::sun::star::sheet::FillMode nFillMode,
79            [in] com::sun::star::sheet::FillDateMode nFillDateMode,
80            [in] double fStep,
81            [in] double fEndValue );
82
83    //-------------------------------------------------------------------------
84
85    /** fills all cells in the range in a way that is specified by the
86        first cell(s) in the range.
87
88        @param nFillDirection
89            specifies the direction to fill the rows/columns of the range.
90
91        @param nSourceCount
92            contains the number of cells in each row/column used to
93            constitute the fill algorithm.
94     */
95    void fillAuto(
96            [in] com::sun::star::sheet::FillDirection nFillDirection,
97            [in] long nSourceCount );
98
99};
100
101//=============================================================================
102
103}; }; }; };
104
105#endif
106
107