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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XCellSeries_idl__
  21 #define __com_sun_star_sheet_XCellSeries_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/FillDirection.idl>
  25 #include <com/sun/star/sheet/FillMode.idl>
  26 #include <com/sun/star/sheet/FillDateMode.idl>
  27
  28
  29 module com {  module sun {  module star {  module sheet {
  30
  31
  32 /** provides methods to fill out a cell range automatically with values
  33     based on a start value, step count and fill mode.
  34
  35     @see com::sun::star::sheet::SheetCellRange
  36  */
  37 published interface XCellSeries: com::sun::star::uno::XInterface
  38 {
  39
  40     /** fills all cells in the range based on the specified settings.
  41
  42         @param nFillDirection
  43             specifies the direction to fill the rows/columns of the range.
  44
  45         @param nFillMode
  46              specifies the type of the series.
  47
  48         @param nFillDateMode
  49              specifies the calculation mode for date values.
  50
  51         @param fStep
  52             contains the value used to increase/decrease the series values.
  53
  54         @param fEndValue
  55             contains the threshold value on which the calculation of the
  56             current series stops.
  57      */
  58     void fillSeries(
  59             [in] com::sun::star::sheet::FillDirection nFillDirection,
  60             [in] com::sun::star::sheet::FillMode nFillMode,
  61             [in] com::sun::star::sheet::FillDateMode nFillDateMode,
  62             [in] double fStep,
  63             [in] double fEndValue );
  64
  65
  66     /** fills all cells in the range in a way that is specified by the
  67         first cell(s) in the range.
  68
  69         @param nFillDirection
  70             specifies the direction to fill the rows/columns of the range.
  71
  72         @param nSourceCount
  73             contains the number of cells in each row/column used to
  74             constitute the fill algorithm.
  75      */
  76     void fillAuto(
  77             [in] com::sun::star::sheet::FillDirection nFillDirection,
  78             [in] long nSourceCount );
  79
  80 };
  81
  82
  83 }; }; }; };
  84
  85 #endif
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */