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