offapi/com/sun/star/sheet/XCellSeries.idl

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