xref: /trunk/main/offapi/com/sun/star/sheet/XGoalSeek.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_XGoalSeek_idl__
29#define __com_sun_star_sheet_XGoalSeek_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_GoalResult_idl__
36#include <com/sun/star/sheet/GoalResult.idl>
37#endif
38
39#ifndef __com_sun_star_table_CellAddress_idl__
40#include <com/sun/star/table/CellAddress.idl>
41#endif
42
43//=============================================================================
44
45module com {  module sun {  module star {  module sheet {
46
47//=============================================================================
48
49/** provides seeking a goal value for a cell.
50 */
51published interface XGoalSeek: com::sun::star::uno::XInterface
52{
53	//-------------------------------------------------------------------------
54
55	/** calculates a value which gives a specified result in a formula.
56
57		@param aFormulaPosition
58			is the address of the formula cell used for the calculation.
59
60		@param aVariablePosition
61			is the address of the cell that is used in the formula as
62			variable.
63
64		@param aGoalValue
65			is the value which should be reached during the goal seek.
66
67		@returns
68			the result of the goal seek, including the value that results
69			in the specified goal, using the specified formula.
70	 */
71	com::sun::star::sheet::GoalResult seekGoal(
72			[in] com::sun::star::table::CellAddress aFormulaPosition,
73			[in] com::sun::star::table::CellAddress aVariablePosition,
74			[in] string aGoalValue );
75
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83
84