offapi/com/sun/star/sheet/XMultipleOperation.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_XMultipleOperation_idl__
  21 #define __com_sun_star_sheet_XMultipleOperation_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/table/CellRangeAddress.idl>
  25 #include <com/sun/star/sheet/TableOperationMode.idl>
  26 #include <com/sun/star/table/CellAddress.idl>
  27
  28
  29 module com {  module sun {  module star {  module sheet {
  30
  31
  32 /** provides a method to apply a Multiple Operations Table to the
  33     cell range.
  34  */
  35 published interface XMultipleOperation: com::sun::star::uno::XInterface
  36 {
  37
  38     /** creates a table of formulas (a "Multiple Operations Table").
  39
  40         <p>The specified formulas are repeated, with references to the
  41         specified cells replaced by references to values in the first
  42         column and/or row of the range.</p>
  43
  44         @param aFormulaRange
  45             the range that contains formula cells (modes
  46             TableOperationMode::ROW or
  47             TableOperationMode::COLUMN) or a single formula
  48             cell (mode TableOperationMode::BOTH).
  49
  50         @param nMode
  51             specifies the calculation mode to fill the cells.
  52
  53         @param aColumnCell
  54             contains the address of the cell that is referenced by
  55             formulas in a row (mode TableOperationMode::ROW)
  56             or by the formula cell used for two value series (mode
  57             TableOperationMode::BOTH). This parameter is not
  58             used if mode is TableOperationMode::COLUMN.
  59
  60         @param aRowCell
  61             contains the address of the cell that is referenced by
  62             formulas in a column (mode TableOperationMode::COLUMN)
  63             or by the formula cell used for two value series (mode
  64             TableOperationMode::BOTH). This parameter is not
  65             used if mode is TableOperationMode::ROW.
  66      */
  67     void setTableOperation(
  68             [in] com::sun::star::table::CellRangeAddress aFormulaRange,
  69             [in] com::sun::star::sheet::TableOperationMode nMode,
  70             [in] com::sun::star::table::CellAddress aColumnCell,
  71             [in] com::sun::star::table::CellAddress aRowCell );
  72
  73 };
  74
  75
  76 }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */