summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XGoalSeek.idl
blob: bcee5001c6d296ee2dd876061e62774b05160e6f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XGoalSeek.idl,v $
 * $Revision: 1.8 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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