AOO410/main/offapi/com/sun/star/sheet/XGoalSeek.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#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