office-gobmx/offapi/com/sun/star/sheet/XGoalSeek.idl
Oliver Bolte 1b5a10f04a INTEGRATION: CWS sb18 (1.5.406); FILE MERGED
2004/05/21 15:03:23 sb 1.5.406.1: #i21150# Added published flag.
2004-06-03 22:07:11 +00:00

117 lines
4.1 KiB
Text

/*************************************************************************
*
* $RCSfile: XGoalSeek.idl,v $
*
* $Revision: 1.6 $
*
* last change: $Author: obo $ $Date: 2004-06-03 23:07:11 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 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
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#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