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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XMultipleOperation_idl__
  29 #define __com_sun_star_sheet_XMultipleOperation_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  36 #include <com/sun/star/table/CellRangeAddress.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_sheet_TableOperationMode_idl__
  40 #include <com/sun/star/sheet/TableOperationMode.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_table_CellAddress_idl__
  44 #include <com/sun/star/table/CellAddress.idl>
  45 #endif
  46
  47 //=============================================================================
  48
  49 module com {  module sun {  module star {  module sheet {
  50
  51 //=============================================================================
  52
  53 /** provides a method to apply a Multiple Operations Table to the
  54     cell range.
  55  */
  56 published interface XMultipleOperation: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** creates a table of formulas (a "Multiple Operations Table").
  61
  62         <p>The specified formulas are repeated, with references to the
  63         specified cells replaced by references to values in the first
  64         column and/or row of the range.</p>
  65
  66         @param aFormulaRange
  67             the range that contains formula cells (modes
  68             <const>TableOperationMode::ROW</const> or
  69             <const>TableOperationMode::COLUMN</const>) or a single formula
  70             cell (mode <const>TableOperationMode::BOTH</const>).
  71
  72         @param nMode
  73             specifies the calculation mode to fill the cells.
  74
  75         @param aColumnCell
  76             contains the address of the cell that is referenced by
  77             formulas in a row (mode <const>TableOperationMode::ROW</const>)
  78             or by the formula cell used for two value series (mode
  79             <const>TableOperationMode::BOTH</const>). This parameter is not
  80             used if mode is <const>TableOperationMode::COLUMN</const>.
  81
  82         @param aRowCell
  83             contains the address of the cell that is referenced by
  84             formulas in a column (mode <const>TableOperationMode::COLUMN</const>)
  85             or by the formula cell used for two value series (mode
  86             <const>TableOperationMode::BOTH</const>). This parameter is not
  87             used if mode is <const>TableOperationMode::ROW</const>.
  88      */
  89     void setTableOperation(
  90             [in] com::sun::star::table::CellRangeAddress aFormulaRange,
  91             [in] com::sun::star::sheet::TableOperationMode nMode,
  92             [in] com::sun::star::table::CellAddress aColumnCell,
  93             [in] com::sun::star::table::CellAddress aRowCell );
  94
  95 };
  96
  97 //=============================================================================
  98
  99 }; }; }; };
 100
 101 #endif
 102