summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/XScenarios.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/sheet/XScenarios.idl67
1 files changed, 67 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XScenarios.idl b/offapi/com/sun/star/sheet/XScenarios.idl
new file mode 100644
index 000000000..c39158df8
--- /dev/null
+++ b/offapi/com/sun/star/sheet/XScenarios.idl
@@ -0,0 +1,67 @@
+/* -*- 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_XScenarios_idl__
+#define __com_sun_star_sheet_XScenarios_idl__
+
+#include <com/sun/star/container/XNameAccess.idl>
+#include <com/sun/star/table/CellRangeAddress.idl>
+
+
+module com { module sun { module star { module sheet {
+
+
+/** provides access via name to the scenarios in a collection and inserting
+ and removing scenarios.
+
+ @see com::sun::star::sheet::Scenarios
+ @see com::sun::star::sheet::Spreadsheet
+ */
+published interface XScenarios: com::sun::star::container::XNameAccess
+{
+
+ /** creates a new scenario and adds it to the collection.
+
+ @param aName
+ the name of the scenario (used i.e. for collection access).
+
+ @param aRanges
+ the cell ranges contained in the scenario.
+
+ @param aComment
+ the user defined comment for the scenario.
+ */
+ void addNewByName(
+ [in] string aName,
+ [in] sequence< com::sun::star::table::CellRangeAddress > aRanges,
+ [in] string aComment );
+
+
+ /** removes a scenario from the collection.
+ */
+ void removeByName( [in] string aName );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */