summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl
parentInitial commit. (diff)
downloadlibreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz
libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl')
-rw-r--r--offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl105
1 files changed, 105 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl b/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl
new file mode 100644
index 000000000..f2b5bec7f
--- /dev/null
+++ b/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl
@@ -0,0 +1,105 @@
+/* -*- 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_XSheetCellRangeContainer_idl__
+#define __com_sun_star_sheet_XSheetCellRangeContainer_idl__
+
+#include <com/sun/star/sheet/XSheetCellRanges.idl>
+#include <com/sun/star/table/CellRangeAddress.idl>
+#include <com/sun/star/container/NoSuchElementException.idl>
+
+
+module com { module sun { module star { module sheet {
+
+
+/** provides methods to access cell ranges in a collection via index and
+ to add and remove cell ranges.
+
+ @see com::sun::star::sheet::SheetCellRanges
+ */
+published interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges
+{
+
+ /** adds the given range to the collection of cell ranges.
+
+ @param aCellRangeAddress
+ contains the address of the new range.
+
+ @param bMergeRanges
+ defines how the range should be added. To merge the ranges
+ takes more time, but the memory usage is lower.
+ */
+ void addRangeAddress(
+ [in] com::sun::star::table::CellRangeAddress aCellRangeAddress,
+ [in] boolean bMergeRanges );
+
+
+ /** removes the given range from the collection of cell ranges.
+
+ @param aCellRangeAddress
+ contains the address of the range to be removed.
+
+ <p>The specified range must fit exactly to an element of the
+ collection. The method does not try to shorten a range.</p>
+
+ @throws com::sun::star::container::NoSuchElementException
+ if the collection does not contain the specified range.
+ */
+ void removeRangeAddress(
+ [in] com::sun::star::table::CellRangeAddress aCellRangeAddress )
+ raises( com::sun::star::container::NoSuchElementException );
+
+
+ /** adds the given ranges to the collection of cell ranges.
+
+ @param aCellRangeAddresses
+ contains a sequence of addresses of all new ranges.
+
+ @param bMergeRanges
+ defines how the ranges should be added. To merge the ranges
+ takes more time, but the memory usage is lower.
+ */
+ void addRangeAddresses(
+ [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses,
+ [in] boolean bMergeRanges );
+
+
+ /** removes the given ranges from the collection of cell ranges.
+
+ @param aCellRangeAddresses
+ contains a sequence of addresses of all ranges to be removed.
+
+ <p>All specified ranges must fit exactly to elements of the
+ collection. The method does not try to shorten ranges.</p>
+
+ @throws com::sun::star::container::NoSuchElementException
+ if the collection does not contain any of the specified ranges.
+ */
+ void removeRangeAddresses(
+ [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses )
+ raises( com::sun::star::container::NoSuchElementException);
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */