offapi/com/sun/star/sheet/XGoalSeek.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: XGoalSeek.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_XGoalSeek_idl__
  32 #define __com_sun_star_sheet_XGoalSeek_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_sheet_GoalResult_idl__
  39 #include <com/sun/star/sheet/GoalResult.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_table_CellAddress_idl__
  43 #include <com/sun/star/table/CellAddress.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module sheet {
  49
  50 //=============================================================================
  51
  52 /** provides seeking a goal value for a cell.
  53  */
  54 published interface XGoalSeek: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** calculates a value which gives a specified result in a formula.
  59
  60         @param aFormulaPosition
  61             is the address of the formula cell used for the calculation.
  62
  63         @param aVariablePosition
  64             is the address of the cell that is used in the formula as
  65             variable.
  66
  67         @param aGoalValue
  68             is the value which should be reached during the goal seek.
  69
  70         @returns
  71             the result of the goal seek, including the value that results
  72             in the specified goal, using the specified formula.
  73      */
  74     com::sun::star::sheet::GoalResult seekGoal(
  75             [in] com::sun::star::table::CellAddress aFormulaPosition,
  76             [in] com::sun::star::table::CellAddress aVariablePosition,
  77             [in] string aGoalValue );
  78
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 #endif
  86