office-gobmx/offapi/com/sun/star/sheet/XCellSeries.idl
2012-01-05 09:18:17 +00:00

101 lines
3.6 KiB
Text

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_sheet_XCellSeries_idl__
#define __com_sun_star_sheet_XCellSeries_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/sheet/FillDirection.idl>
#include <com/sun/star/sheet/FillMode.idl>
#include <com/sun/star/sheet/FillDateMode.idl>
//=============================================================================
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
*/
published 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
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */