1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XGoalSeek_idl__
25#define __com_sun_star_sheet_XGoalSeek_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_GoalResult_idl__
32#include <com/sun/star/sheet/GoalResult.idl>
33#endif
34
35#ifndef __com_sun_star_table_CellAddress_idl__
36#include <com/sun/star/table/CellAddress.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module sheet {
42
43//=============================================================================
44
45/** provides seeking a goal value for a cell.
46 */
47published interface XGoalSeek: com::sun::star::uno::XInterface
48{
49	//-------------------------------------------------------------------------
50
51	/** calculates a value which gives a specified result in a formula.
52
53		@param aFormulaPosition
54			is the address of the formula cell used for the calculation.
55
56		@param aVariablePosition
57			is the address of the cell that is used in the formula as
58			variable.
59
60		@param aGoalValue
61			is the value which should be reached during the goal seek.
62
63		@returns
64			the result of the goal seek, including the value that results
65			in the specified goal, using the specified formula.
66	 */
67	com::sun::star::sheet::GoalResult seekGoal(
68			[in] com::sun::star::table::CellAddress aFormulaPosition,
69			[in] com::sun::star::table::CellAddress aVariablePosition,
70			[in] string aGoalValue );
71
72};
73
74//=============================================================================
75
76}; }; }; };
77
78#endif
79
80