offapi/com/sun/star/sheet/XMultipleOperation.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: XMultipleOperation.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_XMultipleOperation_idl__
  32 #define __com_sun_star_sheet_XMultipleOperation_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_table_CellRangeAddress_idl__
  39 #include <com/sun/star/table/CellRangeAddress.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_sheet_TableOperationMode_idl__
  43 #include <com/sun/star/sheet/TableOperationMode.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_table_CellAddress_idl__
  47 #include <com/sun/star/table/CellAddress.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sheet {
  53
  54 //=============================================================================
  55
  56 /** provides a method to apply a Multiple Operations Table to the
  57     cell range.
  58  */
  59 published interface XMultipleOperation: com::sun::star::uno::XInterface
  60 {
  61     //-------------------------------------------------------------------------
  62
  63     /** creates a table of formulas (a "Multiple Operations Table").
  64
  65         <p>The specified formulas are repeated, with references to the
  66         specified cells replaced by references to values in the first
  67         column and/or row of the range.</p>
  68
  69         @param aFormulaRange
  70             the range that contains formula cells (modes
  71             <const>TableOperationMode::ROW</const> or
  72             <const>TableOperationMode::COLUMN</const>) or a single formula
  73             cell (mode <const>TableOperationMode::BOTH</const>).
  74
  75         @param nMode
  76             specifies the calculation mode to fill the cells.
  77
  78         @param aColumnCell
  79             contains the address of the cell that is referenced by
  80             formulas in a row (mode <const>TableOperationMode::ROW</const>)
  81             or by the formula cell used for two value series (mode
  82             <const>TableOperationMode::BOTH</const>). This parameter is not
  83             used if mode is <const>TableOperationMode::COLUMN</const>.
  84
  85         @param aRowCell
  86             contains the address of the cell that is referenced by
  87             formulas in a column (mode <const>TableOperationMode::COLUMN</const>)
  88             or by the formula cell used for two value series (mode
  89             <const>TableOperationMode::BOTH</const>). This parameter is not
  90             used if mode is <const>TableOperationMode::ROW</const>.
  91      */
  92     void setTableOperation(
  93             [in] com::sun::star::table::CellRangeAddress aFormulaRange,
  94             [in] com::sun::star::sheet::TableOperationMode nMode,
  95             [in] com::sun::star::table::CellAddress aColumnCell,
  96             [in] com::sun::star::table::CellAddress aRowCell );
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif
 105