summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XCellSeries.idl
blob: 1aa90930f7e7b6dd29721ee146dd7ec6636feecd (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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*************************************************************************
 *
 *  $RCSfile: XCellSeries.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2002-10-03 13:08:15 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#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
 */
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