summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/XGoalSeek.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/sheet/XGoalSeek.idl64
1 files changed, 64 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XGoalSeek.idl b/offapi/com/sun/star/sheet/XGoalSeek.idl
new file mode 100644
index 000000000..8737f0219
--- /dev/null
+++ b/offapi/com/sun/star/sheet/XGoalSeek.idl
@@ -0,0 +1,64 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * 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 .
+ */
+
+#ifndef __com_sun_star_sheet_XGoalSeek_idl__
+#define __com_sun_star_sheet_XGoalSeek_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/sheet/GoalResult.idl>
+#include <com/sun/star/table/CellAddress.idl>
+
+
+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
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */