offapi/com/sun/star/sheet/XGoalSeek.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_XGoalSeek_idl__
  21 #define __com_sun_star_sheet_XGoalSeek_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/GoalResult.idl>
  25 #include <com/sun/star/table/CellAddress.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** provides seeking a goal value for a cell.
  32  */
  33 published interface XGoalSeek: com::sun::star::uno::XInterface
  34 {
  35
  36     /** calculates a value which gives a specified result in a formula.
  37
  38         @param aFormulaPosition
  39             is the address of the formula cell used for the calculation.
  40
  41         @param aVariablePosition
  42             is the address of the cell that is used in the formula as
  43             variable.
  44
  45         @param aGoalValue
  46             is the value which should be reached during the goal seek.
  47
  48         @returns
  49             the result of the goal seek, including the value that results
  50             in the specified goal, using the specified formula.
  51      */
  52     com::sun::star::sheet::GoalResult seekGoal(
  53             [in] com::sun::star::table::CellAddress aFormulaPosition,
  54             [in] com::sun::star::table::CellAddress aVariablePosition,
  55             [in] string aGoalValue );
  56
  57 };
  58
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */