1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_XCellSeries_idl__
29#define __com_sun_star_sheet_XCellSeries_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_FillDirection_idl__
36#include <com/sun/star/sheet/FillDirection.idl>
37#endif
38
39#ifndef __com_sun_star_sheet_FillMode_idl__
40#include <com/sun/star/sheet/FillMode.idl>
41#endif
42
43#ifndef __com_sun_star_sheet_FillDateMode_idl__
44#include <com/sun/star/sheet/FillDateMode.idl>
45#endif
46
47//=============================================================================
48
49module com {  module sun {  module star {  module sheet {
50
51//=============================================================================
52
53/** provides methods to fill out a cell range automatically with values
54	based on a start value, step count and fill mode.
55
56	@see com::sun::star::sheet::SheetCellRange
57 */
58published interface XCellSeries: com::sun::star::uno::XInterface
59{
60	//-------------------------------------------------------------------------
61
62	/** fills all cells in the range based on the specified settings.
63
64		@param nFillDirection
65			specifies the direction to fill the rows/columns of the range.
66
67		@param nFillMode
68	 		specifies the type of the series.
69
70		@param nFillDateMode
71	 		specifies the calculation mode for date values.
72
73		@param fStep
74			contains the value used to increase/decrease the series values.
75
76		@param fEndValue
77			contains the threshold value on which the calculation of the
78			current series stops.
79	 */
80	void fillSeries(
81			[in] com::sun::star::sheet::FillDirection nFillDirection,
82			[in] com::sun::star::sheet::FillMode nFillMode,
83			[in] com::sun::star::sheet::FillDateMode nFillDateMode,
84			[in] double fStep,
85			[in] double fEndValue );
86
87	//-------------------------------------------------------------------------
88
89	/** fills all cells in the range in a way that is specified by the
90		first cell(s) in the range.
91
92		@param nFillDirection
93			specifies the direction to fill the rows/columns of the range.
94
95		@param nSourceCount
96			contains the number of cells in each row/column used to
97			constitute the fill algorithm.
98	 */
99	void fillAuto(
100			[in] com::sun::star::sheet::FillDirection nFillDirection,
101			[in] long nSourceCount );
102
103};
104
105//=============================================================================
106
107}; }; }; };
108
109#endif
110
111