/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XGoalSeek.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 05:10:47 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XGoalSeek_idl__
#define __com_sun_star_sheet_XGoalSeek_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sheet_GoalResult_idl__
#include <com/sun/star/sheet/GoalResult.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides seeking a goal value for a cell.
 */
published interface XGoalSeek: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** calculates a value which gives a specified result in a formula.

		@param aFormulaPosition
			is the address of the formula cell used for the calculation.

		@param aVariablePosition
			is the address of the cell that is used in the formula as
			variable.

		@param aGoalValue
			is the value which should be reached during the goal seek.

		@returns
			the result of the goal seek, including the value that results
			in the specified goal, using the specified formula.
	 */
	com::sun::star::sheet::GoalResult seekGoal(
			[in] com::sun::star::table::CellAddress aFormulaPosition,
			[in] com::sun::star::table::CellAddress aVariablePosition,
			[in] string aGoalValue );

};

//=============================================================================

}; }; }; };

#endif

